Skip to content

Latest commit

 

History

History
29 lines (21 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

29 lines (21 loc) · 1.11 KB

Contribution guidelines

Thank you for your interest in improving documentor! Follow these guidelines to contribute effectively and get your patches accepted.

Commit sign-off

Remember to sign-off on your commits by running git commit --signoff before pushing. To understand what this means, read the Linux Kernel Developer's Certificate of Origin.

Submission guidelines

Adhere to the following rules when submitting your PR:

  • Keep it small: Avoid changing too many things at once.
  • Individual PRs: One PR per issue, please.
  • Commit messages: Write meaningful, clear commit messages.
  • Quality assurance: Review your spelling and grammar before submission.
  • Testing: Write tests. Ensure your changes do not break any existing functionality by running make test.
  • Respect the coding style: Ensure your contributions maintain the codebase’s style.

License

All contributions are made under the Apache-2.0 license.