openmediavault/CONTRIBUTING.md
mi-hol c0a9cf2003
Create contributing.md to align with common practice (#1396)
Co-authored-by: Volker Theile <votdev@gmx.de>
2022-09-28 18:08:06 +02:00

1.2 KiB

Contribution rules

Code contributions must satisfy the following conditions. Contributions that do not fulfill these conditions will not be accepted.

  • Before jumping into a PR, be sure to search existing PRs or issues for an open or closed item that relates to your submission.
  • You have to sign the CLA online via GitHub.
  • The coding guidelines outlined in the reference manual must be followed.
  • The feature/improvement must be implemented as generic as possible.
  • The code/feature/improvement must not affect existing functionality.
  • Each commit message in a GitHub pull request must be signed via Signed-off-by: Frank Mustermann <frank.mustermann@xxx.yyy>.
  • If possible, sign your commits with a GPG key.
  • If the PR fixes a GitHub issue, then the line Fixes: https://github.com/openmediavault/openmediavault/issues/<ISSUE_NR> must be included.
  • Make sure your PR has only one commit.
  • New features require comprehensive unit tests. Note: This requirement is usually the biggest hurdle for being merged!