mirror of
https://git.joinsharkey.org/Sharkey/Sharkey.git
synced 2024-11-30 11:03:08 +02:00
Update CONTRIBUTING.md
This commit is contained in:
parent
3ff89fa7ec
commit
5ec78d11d9
1 changed files with 3 additions and 0 deletions
|
@ -16,6 +16,9 @@ Before creating an issue, please check the following:
|
||||||
## Before implementation
|
## Before implementation
|
||||||
When you want to add a feature or fix a bug, **first have the design and policy reviewed in an Issue** (if it is not there, please make one). Without this step, there is a high possibility that the PR will not be merged even if it is implemented.
|
When you want to add a feature or fix a bug, **first have the design and policy reviewed in an Issue** (if it is not there, please make one). Without this step, there is a high possibility that the PR will not be merged even if it is implemented.
|
||||||
|
|
||||||
|
At this point, you also need to clarify the goals of the PR you are creating, and make sure that the other members of the team are aware of them.
|
||||||
|
PRs that do not have a clear set of do's and don'ts tend to be bloated and difficult to review.
|
||||||
|
|
||||||
Also, when you start implementation, assign yourself to the Issue (if you cannot do it yourself, ask another member to assign you). By expressing your intention to work the Issue, you can prevent conflicts in the work.
|
Also, when you start implementation, assign yourself to the Issue (if you cannot do it yourself, ask another member to assign you). By expressing your intention to work the Issue, you can prevent conflicts in the work.
|
||||||
|
|
||||||
## Well-known branches
|
## Well-known branches
|
||||||
|
|
Loading…
Reference in a new issue