|
| 1 | +# Developer Guide |
| 2 | + |
| 3 | +Thank you for taking the time out to contribute to project Antrea! |
| 4 | + |
| 5 | +## Contribute |
| 6 | + |
| 7 | +### Inclusive Naming |
| 8 | + |
| 9 | +For symbol names and documentation, do not introduce new usage of harmful |
| 10 | +language such as 'master / slave' (or 'slave' independent of 'master') and |
| 11 | +'blacklist / whitelist'. For more information about what constitutes harmful |
| 12 | +language and for a reference word replacement list, please refer to the |
| 13 | +[Inclusive Naming Initiative](https://inclusivenaming.org/). |
| 14 | + |
| 15 | +We are committed to removing all harmful language from the project. If you |
| 16 | +detect existing usage of harmful language in code or documentation, please |
| 17 | +report the issue to us or open a Pull Request to address it directly. Thanks! |
| 18 | + |
| 19 | +### Sign-off Your Work |
| 20 | + |
| 21 | +As a CNCF project, Antrea must enforce the [Developer Certificate of |
| 22 | +Origin](https://developercertificate.org/) (DCO) on all Pull Requests. We |
| 23 | +require that for all commits constituting the Pull Request, the commit message |
| 24 | +contains the `Signed-off-by` line with an email address that matches the commit |
| 25 | +author. By adding this line to their commit messages, contributors *sign-off* |
| 26 | +that they adhere to the requirements of the DCO. |
| 27 | + |
| 28 | +Git provides the `-s` command-line option to append the required line |
| 29 | +automatically to the commit message: |
| 30 | + |
| 31 | +```bash |
| 32 | +git commit -s -m 'This is my commit message' |
| 33 | +``` |
| 34 | + |
| 35 | +For an existing commit, you can also use this option with `--amend`: |
| 36 | + |
| 37 | +```bash |
| 38 | +git commit -s --amend |
| 39 | +``` |
| 40 | + |
| 41 | +If more than one person works on something it's possible for more than one |
| 42 | +person to sign-off on it. For example: |
| 43 | + |
| 44 | +```bash |
| 45 | +Signed-off-by: Some Developer [email protected] |
| 46 | +Signed-off-by: Another Developer [email protected] |
| 47 | +``` |
| 48 | + |
| 49 | +We use the [DCO Github App](https://github.com/apps/dco) to enforce that all |
| 50 | +commits in a Pull Request include the required `Signed-off-by` line. If this is |
| 51 | +not the case, the app will report a failed status for the Pull Request and it |
| 52 | +will be blocked from being merged. |
| 53 | + |
| 54 | +Compared to our earlier CLA, DCO tends to make the experience simpler for new |
| 55 | +contributors. If you are contributing as an employee, there is no need for your |
| 56 | +employer to sign anything; the DCO assumes you are authorized to submit |
| 57 | +contributions (it's your responsibility to check with your employer). |
0 commit comments