You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: development/contributing.md
+10-10
Original file line number
Diff line number
Diff line change
@@ -2,42 +2,42 @@
2
2
3
3
This guide aims to walk you through the process of working on issues and Pull Requests (PRs).
4
4
5
-
Bear in mind that you will not be able to complete some steps on your own if you do not have a “write” permission. Feel free to reach out to the maintainers to help you unlock these activities.
5
+
Bear in mind that you will not be able to complete some steps on your own if you do not have “write” permission. Feel free to reach out to the maintainers to help you unlock these activities.
6
6
7
7
## General recommendations
8
8
9
-
Please note that we have a code of conduct (`CODE-OF-CONDUCT.md`). Make sure that you follow it in all of your interactions with the project.
9
+
Please note that we have a [code of conduct](../project/code-of-conduct.md). Make sure that you follow it in all of your interactions with the project.
10
10
11
11
## Issues
12
12
13
13
### Choosing an issue
14
14
15
15
There are two options to look for the issues to contribute to.\
16
-
The first is our ["Up for grabs"](https://github.com/provectus/kafka-ui/projects/11) board. There the issues are sorted by a required experience level (beginner, intermediate, expert).
16
+
The first is our ["Up for grabs"](https://github.com/provectus/kafka-ui/projects/11) board. There the issues are sorted by the required experience level (beginner, intermediate, expert).
17
17
18
-
The second option is to search for ["good first issue"](https://github.com/provectus/kafka-ui/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)-labeled issues. Some of them might not be displayed on the aforementioned board, or vice versa.
18
+
The second option is to search for ["good first issue"](https://github.com/provectus/kafka-ui/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)-labeled issues. Some of them might not be displayed on the aforementioned board or vice versa.
19
19
20
-
You also need to consider labels. You can sort the issues by scope labels, such as `scope/backend`, `scope/frontend` or even `scope/k8s`. If any issue covers several specific areas, and you do not have a required expertise for one of them, just do your part of work — others will do the rest.
20
+
You also need to consider labels. You can sort the issues by scope labels, such as `scope/backend`, `scope/frontend` or even `scope/k8s`. If any issue covers several specific areas, and you do not have the required expertise for one of them, just do your part of the work — others will do the rest.
21
21
22
22
### Grabbing the issue
23
23
24
24
There is a bunch of criteria that make an issue feasible for development.\
25
-
The implementation of any features and/or their enhancements should be reasonable, must be backed by justified requirements (demanded by the community, roadmap plans, etc.). The final decision is left for the maintainers' discretion.
25
+
The implementation of any features and/or their enhancements should be reasonable and must be backed by justified requirements (demanded by the community, roadmap plans, etc.). The final decision is left to the maintainers' discretion.
26
26
27
27
All bugs should be confirmed as such (i.e. the behavior is unintended).
28
28
29
29
Any issue should be properly triaged by the maintainers beforehand, which includes:
30
30
31
31
1. Having a proper milestone set
32
-
2. Having required labels assigned: accepted label, scope labels, etc.
32
+
2. Having required labels assigned: "accepted" label, scope labels, etc.
33
33
34
34
Formally, if these triage conditions are met, you can start to work on the issue.
35
35
36
36
With all these requirements met, feel free to pick the issue you want. Reach out to the maintainers if you have any questions.
37
37
38
38
### Working on the issue
39
39
40
-
Every issue “in-progress” needs to be assigned to a corresponding person. To keep the status of the issue clear to everyone, please keep the card's status updated ("project" card to the right of the issue should match the milestone’s name).
40
+
Every issue “inprogress” needs to be assigned to a corresponding person. To keep the status of the issue clear to everyone, please keep the card's status updated ("project" card to the right of the issue should match the milestone’s name).
41
41
42
42
### Setting up a local development environment
43
43
@@ -47,7 +47,7 @@ Please refer to this guide.
47
47
48
48
### Branch naming
49
49
50
-
In order to keep branch names uniform and easy-to-understand, please use the following conventions for branch naming.
50
+
In order to keep branch names uniform and easy to understand, please use the following conventions for branch naming.
51
51
52
52
Generally speaking, it is a good idea to add a group/type prefix to a branch; e.g., if you are working on a specific branch, you could name it `issues/xxx`.
53
53
@@ -82,7 +82,7 @@ When creating a PR please do the following:
82
82
4. If the PR does not close any of the issues, the PR itself might need to have a milestone set. Reach out to the maintainers to consult.
83
83
5. Assign the PR to yourself. A PR assignee is someone whose goal is to get the PR merged.
84
84
6. Add reviewers. As a rule, reviewers' suggestions are pretty good; please use them.
85
-
7. Upon merging the PR, please use a meaningful commit message, task name should be fine in this case.
85
+
7. Upon merging the PR, please use a meaningful commit message, the task name should be fine in this case.
[Setting your username in Git](https://docs.github.com/en/get-started/getting-started-with-git/setting-your-username-in-git)
13
+
14
+
[Setting your commit email address](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address)
Roadmap exists in a form of a github project board and is located [here](https://github.com/provectus/kafka-ui/projects/8).
7
+
Roadmap exists in a form of a GitHub project board and is located [here](https://github.com/provectus/kafka-ui/projects/8).
8
8
9
9
#### How to use this document
10
10
11
11
The roadmap provides a list of features we decided to prioritize in project development. It should serve as a reference point to understand projects' goals.
12
12
13
-
We do prioritize them based on the feedback from the community, our own vision and other conditions and circumstances.
13
+
We do prioritize them based on the feedback from the community, our own vision, and other conditions and circumstances.
14
14
15
-
The roadmap sets the general way of development. The roadmap is mostly about long-term features. All the features could be re-prioritized, rescheduled or canceled.
15
+
The roadmap sets the general way of development. The roadmap is mostly about long-term features. All the features could be re-prioritized, rescheduled, or canceled.
16
16
17
-
If there's no feature `X`, that **doesn't** mean we're **not** going to implement it. Feel free to raise the issue for the consideration.\
18
-
If a feature you want to see live is not present on roadmap, but there's an issue for the feature, feel free to vote for it using reactions in the issue.
17
+
If there's no feature `X`, that **doesn't** mean we're **not** going to implement it. Feel free to raise the issue for consideration.\
18
+
If a feature you want to see live is not present on the roadmap, but there's an issue with the feature, feel free to vote for it using reactions to the issue.
19
19
20
20
#### How to contribute
21
21
22
22
Since the roadmap consists mostly of big long-term features, implementing them might be not easy for a beginner outside collaborator.
23
23
24
-
A good starting point is checking the [CONTRIBUTING.md](https://github.com/provectus/kafka-ui/blob/master/CONTRIBUTING.md)document.
24
+
A good starting point is checking the [contributing](../development/contributing.md)article.
0 commit comments