ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-06-04 09:31:12 +03:00
Code Issues Projects Releases Wiki Activity

Contributing: <type>/<issue number>/<title> now mandated

Browse Source
This commit is contained in:
Athanasius 2021-06-07 12:10:43 +01:00
parent 3edf4ed069
commit 54b57db329
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Contributing.md
View File

@ -129,12 +129,12 @@ Remember, you should always be working versus a single issue, even if the work i
There might be cases where issues aren't duplicates, but your work still addresses more than one. In that case There might be cases where issues aren't duplicates, but your work still addresses more than one. In that case
pick one for the naming scheme below, but mention all in commit messages and the Pull Request. pick one for the naming scheme below, but mention all in commit messages and the Pull Request.
In all cases the branch should be named as per the scheme `<class>/<issue number>-<title>`: In all cases the branch should be named as per the scheme `<class>/<issue number>/<title>`:
* `<class>` - We have several classes of WIP branch: * `<class>` - We have several classes of WIP branch:
* `fix` - For working on bug fixes, e.g. `fix/184-crash-in-startup` * `fix` - For working on bug fixes, e.g. `fix/184/crash-in-startup`
* `enhancement` - For enhancing an *existing* feature, e.g. `enhancement/192-add-thing-to-wotsit` * `enhancement` - For enhancing an *existing* feature, e.g. `enhancement/192/add-thing-to-wotsit`
* `feature` - For working on *new* features, e.g. `feature/284-allow-users-to-frob` * `feature` - For working on *new* features, e.g. `feature/284/allow-users-to-frob`
* `<issue-number>` is for easy reference when citing the issue number in commit messages. If you're somehow doing * `<issue-number>` is for easy reference when citing the issue number in commit messages. If you're somehow doing
work that's not versus an issue then don't put the `<issue number>-` part in. work that's not versus an issue then don't put the `<issue number>-` part in.