This repository has been archived by the owner on Dec 6, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
51 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Contributing to linkerd-tcp # | ||
|
||
:balloon: Thank you for using the linkerd-tcp project! | ||
|
||
## Getting Help ## | ||
|
||
If you have a question about linkerd-tcp or have encountered problems | ||
using linkerd-tcp, you may [file an issue][issue] or join us on | ||
[Slack][slack]. | ||
|
||
## Submitting Changes ## | ||
|
||
If you'd like to make a change to linkerd-tcp, you should do the | ||
following: | ||
|
||
1. Submit an [issue][issue] describing your proposed change. | ||
2. We will respond to your issue promptly. | ||
3. If your proposed change is accepted, and you haven't already done | ||
so, sign [Buoyant's Contributor License Agreement][cla]. Before we | ||
can accept your patches, our lawyers would like to be assured that: | ||
- The code you're contributing is yours, and you have the right to | ||
license it. | ||
- You're granting us a license to distribute said code under the | ||
terms of this agreement. | ||
4. Fork the linkerd-tcp repo, develop and test your code | ||
changes. See the project's [README](README.md) for further information | ||
about working in this repository. | ||
5. Submit a pull request against linkerd-tcp's `master` branch. | ||
6. Your branch may be merged once all configured checks pass, | ||
including: | ||
- 2 code review approvals, at least 1 of which is from a buoyant member | ||
- The branch has passed tests in CI. | ||
|
||
### Git history ### | ||
|
||
Prior to submitting a pull request, please revise the commit history | ||
of your branch such that each commit is self-explanatory, even without | ||
the context of the pull request, and that it compiles & tests | ||
cleanly. | ||
|
||
Typically, a pull request consists of a single commit. It may | ||
occasionally be preferable to submit a change with several commits, | ||
but each should be a complete change needed to complete a larger | ||
feature. Each commit should be documented appropriately. | ||
|
||
Thank you for getting involved! | ||
:heart: Team Buoyant | ||
|
||
[cla]: https://buoyant.io/cla/ | ||
[issue]: https://github.com/linkerd/linkerd-tcp/issues/new | ||
[slack]: http://slack.linkerd.io/ |