diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..cc5e4755c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,53 @@ +# Contributing +Thank you for your interest in contributing to our project! + +## How to Contribute + +1. Fork the repository +2. Create a new branch for your changes +3. Make your changes +4. Sign your commits with DCO: + ```sh + git commit -s -m "Your commit message" + ``` +5. Push to your fork and submit a pull request + +## Developer Certificate of Origin + +We use the Developer Certificate of Origin (DCO) in lieu of a +Contributor License Agreement (CLA) for all contributions to this +project. DCO is a legally binding statement that asserts that you are +the creator of your contribution and that you wish to allow us to use +it in this project. + + +When you contribute to this repository with a pull request, you need +to sign-off that you agree to the DCO. You do this by adding a +`Signed-off-by` line to your commit messages containing your name and +email: + +``` +git commit -s -m "Your commit message" +``` + +This will automatically add a sign-off message to your +commit. Alternatively, you can manually add: + +```sh +Signed-off-by: John Doe +``` + +## Code Guidelines + +- Keep code clean and simple +- Follow existing code style +- Update documentation if needed + +## Need Help? + +Create an issue if you: +- Found a bug +- Have a feature request +- Need help with something + +Thank you for contributing!