Many Markdown tweaks

This commit is contained in:
XhmikosR
2019-12-12 15:49:55 +02:00
parent aa8e82dbbe
commit 825db6caa4
49 changed files with 978 additions and 582 deletions
+4 -5
View File
@@ -3,18 +3,17 @@ Pi-hole enforces the Developer Certificate of Origin (DCO) on Pull Requests. It
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, 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. See [this guide for how to sign-off correctly](./how-to-signoff.md).
#### 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.
+23 -9
View File
@@ -1,33 +1,47 @@
Pi-hole requires a sign-off message in the following format appear on each commit in the pull request:
```
```text
This is my commit message
Signed-off-by: Random J Developer <random@developer.example.org>
```
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 commit --signoff --message 'This is my commit message'```
```bash
git commit --signoff --message 'This is my commit message'
```
```$ git commit -s -m "This is my commit message"```
```bash
git commit -s -m "This is my commit message"
```
This will use your default git configuration which is found in `.git/config` and usually it is the `username systemaddress` of the machine which you are using.
To change this, you can use the following commands (Note these only change the current repo settings, you will need to add `--global` for these commands to change the installation default).
Your name:
```$ git config user.name "FIRST_NAME LAST_NAME"```
Your name:
Your email:
```$ git config user.email "MY_NAME@example.com"```
```bash
git config user.name "FIRST_NAME LAST_NAME"
```
Your email:
```bash
git config user.email "MY_NAME@example.com"
```
#### How to amend a sign-off
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```
```bash
git commit --amend --signoff
```
If you've pushed your changes to Github already you'll need to force push your branch after this with `git push -f`.