Skip to content

Commit 9d2860c

Browse files
committed
Update CONTRIBUTING.md
Signed-off-by: Mario Loriedo <[email protected]>
1 parent 777415d commit 9d2860c

File tree

2 files changed

+134
-1
lines changed

2 files changed

+134
-1
lines changed

CONTRIBUTING.md

+130-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,130 @@
1-
# Contributing guidelines
1+
# Contributing Guide
2+
3+
[Instructions](https://contribute.cncf.io/maintainers/github/templates/required/contributing/#introduction)
4+
5+
* [New Contributor Guide](#contributing-guide)
6+
* [Ways to Contribute](#ways-to-contribute)
7+
* [Find an Issue](#find-an-issue)
8+
* [Ask for Help](#ask-for-help)
9+
* [Pull Request Lifecycle](#pull-request-lifecycle)
10+
* [Development Environment Setup](#development-environment-setup)
11+
* [Sign Your Commits](#sign-your-commits)
12+
* [Pull Request Checklist](#pull-request-checklist)
13+
14+
Welcome! We are glad that you want to contribute to our project! 💖
15+
16+
As you get started, you are in the best position to give us feedback on areas of
17+
our project that we need help with including:
18+
19+
* Problems found during setting up a new developer environment
20+
* Gaps in our Quickstart Guide or documentation
21+
* Bugs in our automation scripts
22+
23+
If anything doesn't make sense, or doesn't work when you run it, please open a
24+
bug report and let us know!
25+
26+
## Ways to Contribute
27+
28+
[Instructions](https://contribute.cncf.io/maintainers/github/templates/required/contributing/#ways-to-contribute)
29+
30+
We welcome many different types of contributions including:
31+
32+
* New features
33+
* Builds, CI/CD
34+
* Bug fixes
35+
* Documentation
36+
* Issue Triage
37+
* Answering questions on Slack/Mailing List
38+
* Web design
39+
* Communications / Social Media / Blog Posts
40+
* Release management
41+
42+
Not everything happens through a GitHub pull request. Please
43+
[contact us on Kubernetes Slack](https://kubernetes.slack.com/archives/C02SX9E5B55)
44+
and let's discuss how we can work together.
45+
46+
## Find an Issue
47+
48+
[Instructions](https://contribute.cncf.io/maintainers/github/templates/required/contributing/#find-an-issue)
49+
50+
We have good first issues for new contributors and help wanted issues suitable
51+
for any contributor. [good first issue](TODO) has extra information to
52+
help you make your first contribution. [help wanted](TODO) are issues
53+
suitable for someone who isn't a core maintainer and is good to move onto after
54+
your first pull request.
55+
56+
Sometimes there won’t be any issues with these labels. That’s ok! There is
57+
likely still something for you to work on. If you want to contribute but you
58+
don’t know where to start or can't find a suitable issue, you can ⚠️ **explain how people can ask for an issue to work on**.
59+
60+
Once you see an issue that you'd like to work on, please post a comment saying
61+
that you want to work on it. Something like "I want to work on this" is fine.
62+
63+
## Ask for Help
64+
65+
[Instructions](https://contribute.cncf.io/maintainers/github/templates/required/contributing/#ask-for-help)
66+
67+
The best way to reach us with a question when contributing is to ask on:
68+
69+
⚠️ **Pick the way(s) that you prefer people ask for help**
70+
71+
* The original github issue
72+
* The developer mailing list
73+
* Our Slack channel
74+
75+
## Pull Request Lifecycle
76+
77+
[Instructions](https://contribute.cncf.io/maintainers/github/templates/required/contributing/#pull-request-lifecycle)
78+
79+
⚠️ **Explain your pull request process**
80+
81+
## Development Environment Setup
82+
83+
[Instructions](https://contribute.cncf.io/maintainers/github/templates/required/contributing/#development-environment-setup)
84+
85+
⚠️ **Explain how to set up a development environment**
86+
87+
## Sign Your Commits
88+
89+
[Instructions](https://contribute.cncf.io/maintainers/github/templates/required/contributing/#sign-your-commits)
90+
91+
⚠️ **Keep either the DCO or CLA section depending on which you use**
92+
93+
### DCO
94+
Licensing is important to open source projects. It provides some assurances that
95+
the software will continue to be available based under the terms that the
96+
author(s) desired. We require that contributors sign off on commits submitted to
97+
our project's repositories. The [Developer Certificate of Origin
98+
(DCO)](https://probot.github.io/apps/dco/) is a way to certify that you wrote and
99+
have the right to contribute the code you are submitting to the project.
100+
101+
You sign-off by adding the following to your commit messages. Your sign-off must
102+
match the git user and email associated with the commit.
103+
104+
This is my commit message
105+
106+
Signed-off-by: Your Name <[email protected]>
107+
108+
Git has a `-s` command line option to do this automatically:
109+
110+
git commit -s -m 'This is my commit message'
111+
112+
If you forgot to do this and have not yet pushed your changes to the remote
113+
repository, you can amend your commit with the sign-off by running
114+
115+
git commit --amend -s
116+
117+
### CLA
118+
We require that contributors have signed our Contributor License Agreement (CLA).
119+
120+
⚠️ **Explain how to sign the CLA**
121+
122+
## Pull Request Checklist
123+
124+
When you submit your pull request, or you push new commits to it, our automated
125+
systems will run some checks on your new code. We require that your pull request
126+
passes these checks, but we also have more criteria than just that before we can
127+
accept and merge it. We recommend that you check the following things locally
128+
before you submit your code:
129+
130+
⚠️ **Create a checklist that authors should use before submitting a pull request**

OWNERS

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
reviewers:
2+
- l0rd
3+
approvers:
4+
- l0rd

0 commit comments

Comments
 (0)