Skip to content

Commit dd850e5

Browse files
authored
Merge pull request #22 from Jashpatel1/Jashpatel1/Docs
added CONTRIBUTING.md
2 parents d53d926 + e08323b commit dd850e5

1 file changed

Lines changed: 55 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# <a name="contributing">Contributing Overview</a>
2+
Please do! Thanks for your help improving the project! :balloon:
3+
4+
All contributors are welcome. Please see the [newcomers welcome guide](https://docs.google.com/document/d/17OPtDE_rdnPQxmk2Kauhm3GwXF1R5dZ3Cj8qZLKdo5E/edit) for how, where and why to contribute. This project is community-built and welcomes collaboration. Contributors are expected to adhere to our [Code of Conduct](.CODE_OF_CONDUCT.md).
5+
6+
Not sure where to start? First, see the [newcomers welcome guide](https://docs.google.com/document/d/17OPtDE_rdnPQxmk2Kauhm3GwXF1R5dZ3Cj8qZLKdo5E/edit). Grab an open issue with the [help-wanted label](../../labels/help%20wanted) and jump in. Join the [Slack account](http://slack.layer5.io) and engage in conversation. Create a [new issue](/../../issues/new/choose) if needed. All [pull requests](/../../pulls) should reference an open [issue](/../../issues). Include keywords in your pull request descriptions, as well as commit messages, to [automatically close issues in GitHub](https://help.github.com/en/github/managing-your-work-on-github/closing-issues-using-keywords).
7+
8+
**Sections**
9+
- <a name="contributing">General Contribution Flow</a>
10+
- <a href="#commit-signing">Developer Certificate of Origin</a>
11+
12+
## <a name="commit-signing">Signing-off on Commits (Developer Certificate of Origin)</a>
13+
14+
To contribute to this project, you must agree to the Developer Certificate of
15+
Origin (DCO) for each commit you make. The DCO is a simple statement that you,
16+
as a contributor, have the legal right to make the contribution.
17+
18+
See the [DCO](https://developercertificate.org) file for the full text of what you must agree to
19+
and how it works [here](https://github.com/probot/dco#how-it-works).
20+
To signify that you agree to the DCO for contributions, you simply add a line to each of your
21+
git commit messages:
22+
23+
```
24+
Signed-off-by: Jane Smith <jane.smith@example.com>
25+
```
26+
27+
In most cases, you can add this signoff to your commit automatically with the
28+
`-s` or `--signoff` flag to `git commit`. You must use your real name and a reachable email
29+
address (sorry, no pseudonyms or anonymous contributions). An example of signing off on a commit:
30+
```
31+
$ commit -s -m “my commit message w/signoff”
32+
```
33+
34+
To ensure all your commits are signed, you may choose to add this alias to your global ```.gitconfig```:
35+
36+
*~/.gitconfig*
37+
```
38+
[alias]
39+
amend = commit -s --amend
40+
cm = commit -s -m
41+
commit = commit -s
42+
```
43+
Or you may configure your IDE, for example, Visual Studio Code to automatically sign-off commits for you:
44+
45+
<a href="https://user-images.githubusercontent.com/7570704/64490167-98906400-d25a-11e9-8b8a-5f465b854d49.png" ><img src="https://user-images.githubusercontent.com/7570704/64490167-98906400-d25a-11e9-8b8a-5f465b854d49.png" width="50%"><a>
46+
47+
# <a name="maintaining"> Reviews</a>
48+
All contributors are invited to review pull requests. See this short video on [how to review a pull request](https://www.youtube.com/watch?v=isLfo7jfE6g&feature=youtu.be).
49+
50+
# New to Git?
51+
Resources: https://lab.github.com and https://try.github.com/
52+
53+
### License
54+
55+
This repository and site are available as open source under the terms of the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0).

0 commit comments

Comments
 (0)