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