diff --git a/docs/guides/github/contributing.md b/docs/guides/github/contributing.md index 88215c5..0c7f857 100644 --- a/docs/guides/github/contributing.md +++ b/docs/guides/github/contributing.md @@ -17,6 +17,10 @@ Contributors *sign-off* that they adhere to these requirements by adding a Signe #### DCO Failures +The Pi-hole project uses a DCO bot for all GitHub pulls to verify that each commit is signed off. When you create your pull request, it will automaticaly be verified by this bot. An example of what to expect is below. + +![Screenshot](../../images/github-commit-bots.png) + 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 or interactively in the rebase comment editing process, and force push. For example, if you have 2 commits in your history (Note the ~2): ```bash diff --git a/docs/guides/github/how-to-signoff.md b/docs/guides/github/how-to-signoff.md index 2cb3259..a3cb6ed 100644 --- a/docs/guides/github/how-to-signoff.md +++ b/docs/guides/github/how-to-signoff.md @@ -4,11 +4,11 @@ This is my commit message Signed-off-by: Random J Developer ``` -The text can either be manually added to your commit body, or you can add either -s or --signoff to your usual git commit commands. +The text can either be manually added to your commit body, or you can add either `-s` or `--signoff` to your usual git commit commands. #### Creating your signoff -Git has a -s | --signoff command line option to append this automatically to your commit message: +Git has a `-s | --signoff` command line option to append this automatically to your commit message: ```$ git commit --signoff --message 'This is my commit message'``` diff --git a/docs/images/github-commit-bots.png b/docs/images/github-commit-bots.png new file mode 100644 index 0000000..7425dd6 Binary files /dev/null and b/docs/images/github-commit-bots.png differ diff --git a/mkdocs.yml b/mkdocs.yml index e498bfa..4c1ebae 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -60,6 +60,9 @@ pages: - 'Install from source': "ftldns/compile.md" - 'Debugging FTLDNS': "ftldns/debugging.md" - 'In-depth manual': "ftldns/in-depth.md" +- 'Contributing': + - 'Contributing on Github': guides/github/contributing.md + - 'How to sign-off commits': guides/github/how-to-signoff.md - 'Guides': - 'Pi-hole as All-Around DNS Solution': guides/unbound.md - 'Configuring DNS-Over-HTTPS on Pi-hole': guides/dns-over-https.md @@ -78,9 +81,6 @@ pages: - 'Optional: Dual operation: LAN & VPN at the same time': 'guides/vpn/dual-operation.md' - 'Optional: Full and DNS-only': 'guides/vpn/dual-VPN.md' - 'Optional: Dynamic DNS': 'guides/vpn/dynDNS.md' - - 'Contributing': - - 'Contributing on Github': guides/github/contributing.md - - 'How to sign-off commits': guides/github/how-to-signoff.md extra: social: - type: globe