|
| 1 | +# Contributing to Conduit # |
| 2 | + |
| 3 | +:balloon: Thanks for your help improving the project! |
| 4 | + |
| 5 | +## Getting Help ## |
| 6 | + |
| 7 | +If you have a question about Conduit or have encountered problems using it, |
| 8 | +start by [asking a question in the forums][discourse] or join us in the |
| 9 | +[#conduit Slack channel][slack]. |
| 10 | + |
| 11 | +## Certificate of Origin ## |
| 12 | + |
| 13 | +By contributing to this project you agree to the Developer Certificate of |
| 14 | +Origin (DCO). This document was created by the Linux Kernel community and is a |
| 15 | +simple statement that you, as a contributor, have the legal right to make the |
| 16 | +contribution. See the [DCO](DCO) file for details. |
| 17 | + |
| 18 | +In practice, just add a line to every git commit message: |
| 19 | + |
| 20 | +``` |
| 21 | +Signed-off-by: Jane Smith <jane.smith@example.com> |
| 22 | +``` |
| 23 | + |
| 24 | +Use your real name (sorry, no pseudonyms or anonymous contributions). |
| 25 | + |
| 26 | +If you set your `user.name` and `user.email` git configs, you can sign your |
| 27 | +commit automatically with `git commit -s`. |
| 28 | + |
| 29 | +## Submitting a Pull Request ## |
| 30 | + |
| 31 | +Do you have an improvement? |
| 32 | + |
| 33 | +1. Submit an [issue][issue] describing your proposed change. |
| 34 | +2. We will try to respond to your issue promptly. |
| 35 | +3. Fork this repo, develop and test your code changes. See the project's [README](README.md) for further information about working in this repository. |
| 36 | +4. Submit a pull request against this repo's `master` branch. |
| 37 | +5. Your branch may be merged once all configured checks pass, including: |
| 38 | + - 2 code review approvals, at least 1 of which is from a [runconduit organization member][members]. |
| 39 | + - The branch has passed tests in CI. |
| 40 | + |
| 41 | +## Committing ## |
| 42 | + |
| 43 | +We prefer squash or rebase commits so that all changes from a branch are |
| 44 | +committed to master as a single commit. All pull requests are squashed when |
| 45 | +merged, but rebasing prior to merge gives you better control over the commit |
| 46 | +message. |
| 47 | + |
| 48 | +### Commit messages ### |
| 49 | + |
| 50 | +Finalized commit messages should be in the following format: |
| 51 | + |
| 52 | +``` |
| 53 | +Subject |
| 54 | +
|
| 55 | +Problem |
| 56 | +
|
| 57 | +Solution |
| 58 | +
|
| 59 | +Validation |
| 60 | +
|
| 61 | +Fixes #[GitHub issue ID] |
| 62 | +``` |
| 63 | + |
| 64 | +#### Subject #### |
| 65 | + |
| 66 | +- one line, <= 50 characters |
| 67 | +- describe what is done; not the result |
| 68 | +- use the active voice |
| 69 | +- capitalize first word and proper nouns |
| 70 | +- do not end in a period — this is a title/subject |
| 71 | +- reference the GitHub issue by number |
| 72 | + |
| 73 | +##### Examples ##### |
| 74 | + |
| 75 | +``` |
| 76 | +bad: server disconnects should cause dst client disconnects. |
| 77 | +good: Propagate disconnects from source to destination |
| 78 | +``` |
| 79 | + |
| 80 | +``` |
| 81 | +bad: support tls servers |
| 82 | +good: Introduce support for server-side TLS (#347) |
| 83 | +``` |
| 84 | + |
| 85 | +#### Problem #### |
| 86 | + |
| 87 | +Explain the context and why you're making that change. What is the problem |
| 88 | +you're trying to solve? In some cases there is not a problem and this can be |
| 89 | +thought of as being the motivation for your change. |
| 90 | + |
| 91 | +#### Solution #### |
| 92 | + |
| 93 | +Describe the modifications you've made. |
| 94 | + |
| 95 | +#### Validation #### |
| 96 | + |
| 97 | +Describe the testing you've done to validate your change. Performance-related |
| 98 | +changes should include before- and after- benchmark results. |
| 99 | + |
| 100 | +[discourse]: https://discourse.linkerd.io/c/conduit |
| 101 | +[issue]: https://github.com/runconduit/conduit/issues/new |
| 102 | +[members]: https://github.com/orgs/runconduit/people |
| 103 | +[slack]: http://slack.linkerd.io/ |
0 commit comments