diff --git a/Contributing-to-the-project.md b/Contributing-to-the-project.md deleted file mode 100644 index 5387d36..0000000 --- a/Contributing-to-the-project.md +++ /dev/null @@ -1,51 +0,0 @@ -# TO BE REMOVED (already ported) - -Pi-hole enforces the [Developer Certificate of Origin](https://developercertificate.org/) (DCO) on Pull Requests. It requires all commit messages to contain the `Signed-off-by` line with an email address that matches the commit author and the name on your GitHub account. - -The Developer Certificate of Origin (DCO) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. Here is the full [text of the DCO](https://developercertificate.org/), reformatted for readability: - -> -> By making a contribution to this project, I certify that: -> -> 1. The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or -> -> 2. The contribution is based upon previous work that, to the best of my knowledge, is covered under an > appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or -> -> 3. The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. -> -> 4. I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. - -Contributors _sign-off_ that they adhere to these requirements by adding a `Signed-off-by` line to commit messages. - -``` -This is my commit message - -Signed-off-by: Random J Developer -``` - -[[How To Signoff]] - -Git even has a `-s | --signoff` command line option to append this automatically to your commit message: - -`$ git commit --signoff --message 'This is my commit message'` - -[[How to amend a Signoff]] - -If you have authored a commit that is missing the `Signed-off-by` line, you can amend your commits -and push them to GitHub - -`$ git commit --amend --signoff` - -![DCO Failed PR](https://cloud.githubusercontent.com/assets/173/24482273/a35dc23e-14b5-11e7-9371-fd241873e2c3.png) - -[[ DCO Failures ]] - -If your Pull Request fails the DCO check, it's necessary to fix the entire commit history in the PR. Although this is a situation we'd like to avoid the best practice is to squash the commit history to a single commit, append the DCO sign-off as described [[above|How to amend a Signoff]] or interactively in the rebase comment editing process, and force push. For example, if you have 2 commits in your history (Note the `~2`): - -``` -git rebase --interactive HEAD~2 -(interactive squash + DCO append) -git push origin --force -``` - -Note, that in general rewriting history in this way is something that can cause issues with the review process and this should only be done to correct a DCO mistake. \ No newline at end of file