Skip to content

Commit a35ebdd

Browse files
committed
Add CONTRIBUTING.md file
Signed-off-by: Sergio Castaño Arteaga <[email protected]>
1 parent 1d3680e commit a35ebdd

File tree

2 files changed

+92
-0
lines changed

2 files changed

+92
-0
lines changed

CONTRIBUTING.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Contributing Guide
2+
3+
The GitVote project accepts contributions via [GitHub pull requests](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests). This document outlines the process to help get your contribution accepted.
4+
5+
## Issues and discussions
6+
7+
Feature requests, bug reports, and support requests all occur through GitHub issues and discussions. If you would like to file an issue, view existing issues, or comment on an issue please engage with issues at <https://github.com/cncf/gitvote/issues>. You can create new discussions, view existing ones and comment on them at <https://github.com/cncf/gitvote/discussions>.
8+
9+
## Pull Requests
10+
11+
All changes to the source code and documentation are made through [GitHub pull requests](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests). If you would like to make a change to the source, documentation, or other component in the repository please open a pull request with the change.
12+
13+
If you are unsure if the change will be welcome you may want to file an issue first. The issue can detail the change and you can get feedback from the maintainers prior to starting to make the change.
14+
15+
You can find the existing pull requests at <https://github.com/cncf/gitvote/pulls>.
16+
17+
## Developer Certificate of Origin
18+
19+
The GitVote project uses a [Developers Certificate of Origin (DCO)](https://developercertificate.org/) to sign-off that you have the right to contribute the code being contributed. The full text of the DCO reads:
20+
21+
```text
22+
Developer Certificate of Origin
23+
Version 1.1
24+
25+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
26+
1 Letterman Drive
27+
Suite D4700
28+
San Francisco, CA, 94129
29+
30+
Everyone is permitted to copy and distribute verbatim copies of this
31+
license document, but changing it is not allowed.
32+
33+
34+
Developer's Certificate of Origin 1.1
35+
36+
By making a contribution to this project, I certify that:
37+
38+
(a) The contribution was created in whole or in part by me and I
39+
have the right to submit it under the open source license
40+
indicated in the file; or
41+
42+
(b) The contribution is based upon previous work that, to the best
43+
of my knowledge, is covered under an appropriate open source
44+
license and I have the right under that license to submit that
45+
work with modifications, whether created in whole or in part
46+
by me, under the same open source license (unless I am
47+
permitted to submit under a different license), as indicated
48+
in the file; or
49+
50+
(c) The contribution was provided directly to me by some other
51+
person who certified (a), (b) or (c) and I have not modified
52+
it.
53+
54+
(d) I understand and agree that this project and the contribution
55+
are public and that a record of the contribution (including all
56+
personal information I submit with it, including my sign-off) is
57+
maintained indefinitely and may be redistributed consistent with
58+
this project or the open source license(s) involved.
59+
```
60+
61+
Every commit needs to have signoff added to it with a message like:
62+
63+
```text
64+
Signed-off-by: Joe Smith <[email protected]>
65+
```
66+
67+
Git makes doing this fairly straight forward. First, please use your real name (sorry, no pseudonyms or anonymous contributions).
68+
69+
If you set your `user.name` and `user.email` in your git configuration, you can sign your commit automatically with `git commit -s` or `git commit --signoff`.
70+
71+
Signed commits in the git log will look something like:
72+
73+
```text
74+
Author: Joe Smith <[email protected]>
75+
Date: Thu Feb 2 11:41:15 2018 -0800
76+
77+
Update README
78+
79+
Signed-off-by: Joe Smith <[email protected]>
80+
```
81+
82+
Notice how the `Author` and `Signed-off-by` lines match. If they do not match the PR will be rejected by the automated DCO check.
83+
84+
If more than one person contributed to a commit than there can be more than one `Signed-off-by` line where each line is a signoff from a different person who contributed to the commit.

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,14 @@ Once the vote time is up, the vote will be automatically closed and the results
7171

7272
![create-vote](docs/screenshots/vote-closed.png)
7373

74+
## Contributing
75+
76+
Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for more details.
77+
78+
## Code of Conduct
79+
80+
This project follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
81+
7482
## License
7583

7684
GitVote is an Open Source project licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).

0 commit comments

Comments
 (0)