Skip to content

Commit df73fa0

Browse files
kimgarcellanotzdybal
authored andcommitted
Add contribution guide
1 parent 647c03a commit df73fa0

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

CONTRIBUTING.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing
2+
3+
## Finding an Issue
4+
5+
Issue labels are used to track various tasks. The labels can describe priority, type, and status of each issue.
6+
7+
Labels may also be used to search for issues you would like to work on. The following labels are open to contributions:
8+
9+
- **Issues available for community contribution:**
10+
- `good first issue`: Open to participation from the community and welcome to new contributors
11+
- `help wanted`: Open to participation from the community and not necessarily beginner-friendly
12+
13+
No explicit permission is needed to start working on these types of issues.
14+
15+
You can [find issue labels here](https://github.com/celestiaorg/go-cnc/labels) to see what matches your skills and familiarity with the project.
16+
17+
## Contribution Process
18+
19+
If you've found an issue you would like to work on, follow these steps to make your contribution:
20+
21+
1. Comment on the issue to claim. This avoids potential conflicts with others also interested in the issue.
22+
- It is recommended to tag the user who opened the issue and ask that the issue gets assigned to you.
23+
2. Write your code and submit your pull request when ready. Link to the related issue.
24+
3. Wait for code review and address any questions as soon as you can.
25+
26+
**Collaboration is encouraged**: If someone has claimed an issue you were interested in, contributors may review each other's pull requests. We appreciate contributors that collaborate in a kind, constructive manner.
27+
28+
## Creating a New Issue
29+
30+
Before creating a new issue, please search the GitHub repository for similar issues that have already been posted.
31+
32+
If you want to work on something that has no existing GitHub issue, follow these steps:
33+
34+
1. Create a new GitHub issue to propose your changes. Identify the problem that your issue addresses. Explain your steps for implementation and rationale for the proposed changes.
35+
- We are reluctant to accept pull requests with no related issue created first.
36+
37+
2. Wait for the project maintainer to review and approve your issue for accepting pull requests.
38+
39+
3. If your issue has been approved, you may self-assign the issue and start work on code, following the [Contribution Process](#contribution-process).

0 commit comments

Comments
 (0)