Skip to content

Commit cb784f7

Browse files
authored
docs: add contribution guide (#611)
Signed-off-by: pirog-spb <[email protected]>
1 parent de7e47d commit cb784f7

2 files changed

Lines changed: 116 additions & 5 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# Contributing Guide
2+
3+
This contributing guide is based on [CNCF template](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+
* [Ask for Help](#ask-for-help)
8+
* [Development Environment Setup](#development-environment-setup)
9+
* [Sign Your Commits](#sign-your-commits)
10+
* [Pull Request Checklist](#pull-request-checklist)
11+
12+
<!-- * [Pull Request Lifecycle](#pull-request-lifecycle) -->
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+
We welcome many different types of contributions including:
29+
30+
* New features
31+
* Builds, CI/CD
32+
* Bug fixes
33+
* Documentation
34+
* Testing
35+
36+
Almost everything happens through a GitHub pull request. Please see also [discussions](https://github.com/edgecomllc/eupf/discussions).
37+
38+
<!--
39+
## Find an Issue
40+
41+
[Instructions](https://contribute.cncf.io/maintainers/github/templates/required/contributing/#find-an-issue)
42+
43+
We have good first issues for new contributors and help wanted issues suitable
44+
for any contributor. [good first issue](TODO) has extra information to
45+
help you make your first contribution. [help wanted](TODO) are issues
46+
suitable for someone who isn't a core maintainer and is good to move onto after
47+
your first pull request.
48+
49+
Sometimes there won’t be any issues with these labels. That’s ok! There is
50+
likely still something for you to work on. If you want to contribute but you
51+
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**.
52+
53+
Once you see an issue that you'd like to work on, please post a comment saying
54+
that you want to work on it. Something like "I want to work on this" is fine.
55+
-->
56+
57+
## Ask for Help
58+
59+
The best way to reach us with a question when contributing is to ask on:
60+
61+
* The original github issue
62+
* The discussion
63+
64+
<!--
65+
## Pull Request Lifecycle
66+
67+
[Instructions](https://contribute.cncf.io/maintainers/github/templates/required/contributing/#pull-request-lifecycle)
68+
69+
⚠️ **Explain your pull request process**
70+
-->
71+
72+
73+
## Development Environment Setup
74+
75+
[Instructions](https://github.com/edgecomllc/eupf?tab=readme-ov-file#running-from-sources)
76+
77+
## Sign Your Commits
78+
79+
Licensing is important to open source projects. It provides some assurances that
80+
the software will continue to be available based under the terms that the
81+
author(s) desired. We require that contributors sign off on commits submitted to
82+
our project's repositories. We use the [Developer Certificate of Origin
83+
(DCO)](https://probot.github.io/apps/dco/) as a way to certify that you wrote and
84+
have the right to contribute the code you are submitting to the project.
85+
86+
You sign-off by adding the following to your commit messages. Your sign-off must
87+
match the git user and email associated with the commit.
88+
89+
This is my commit message
90+
91+
Signed-off-by: Your Name <[email protected]>
92+
93+
Git has a `-s` command line option to do this automatically:
94+
95+
git commit -s -m 'This is my commit message'
96+
97+
If you forgot to do this and have not yet pushed your changes to the remote
98+
repository, you can amend your commit with the sign-off by running
99+
100+
git commit --amend -s
101+
102+
## Pull Request Checklist
103+
104+
When you submit your pull request, or you push new commits to it, our automated
105+
systems will run some checks on your new code. We require that your pull request
106+
passes these checks, but we also have more criteria than just that before we can
107+
accept and merge it. We recommend that you check the following things locally
108+
before you submit your code:
109+
110+
- [x] It passes tests: run the following command to run all of the tests locally: `go test -v ./cmd/...`
111+
- [x] Impacted code has new or updated tests
112+
- [x] Documentation created/updated
113+
- [x] All tests succeed when run by the CI build on a pull request before it is merged
114+
- [x] PR name and merge commit message are satisfy [Conventional Commits specification](https://www.conventionalcommits.org/) in order to keep [Release Notes](https://github.com/edgecomllc/eupf/releases) and main branch history clean
115+

‎README.md‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -249,11 +249,7 @@ You can also define several build arguments to configure eUPF image: `docker bui
249249

250250
## Contribution
251251

252-
Please create an issue to report a bug or share an idea.
253-
254-
## Translated docs
255-
256-
Please check [this link](./docs/docs-ru_ru/readme.md) to find translated docs.
252+
Please create an issue to report a bug or share an idea. See our [Contributing Guide](./CONTRIBUTING.md) for details.
257253

258254
## License
259255
This project is licensed under the [Apache-2.0 Creative Commons License](https://www.apache.org/licenses/LICENSE-2.0) - see the [LICENSE file](./LICENSE) for details

0 commit comments

Comments
 (0)