ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-13 07:47:14 +03:00
Code Issues Projects Releases Wiki Activity

Contributing.md: develop is default branch, XXX- issue number optional

Browse Source
This commit is contained in:
Athanasius 2020-07-06 16:05:09 +01:00
parent 733047c11b
commit 65793bce24
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Contributing.md
View File

@ -48,9 +48,9 @@ then the HEAD of this Branch should always point to the code that was used in th
* `master` - To avoid accidental commits that could have unintended consequences we do NOT use this branch. * `master` - To avoid accidental commits that could have unintended consequences we do NOT use this branch.
see `develop` or `stable` instead. However, whenever a new stable release is made `master` should be fast-forwarded see `develop` or `stable` instead. However, whenever a new stable release is made `master` should be fast-forwarded
to remain in sync with `stable`, as this is the default branch for code display on GitHub. Anyone working on to remain in sync with `stable`, as this is the default branch for git (but we've set GitHub to use `develop`
something without first reading these guidelines is also likely to have worked on either local `master` as the default branch). Anyone working on something without first reading these guidelines is also likely to
directly, or a branch based on it. have worked on either local `master` directly, or a branch based on it.
* `releases` - Currently the version of the `edmarketconnector.xml` 'appcast' file in this branch is what live * `releases` - Currently the version of the `edmarketconnector.xml` 'appcast' file in this branch is what live
clients check to be notified of new versions. This can potentially be replaced with the `stable` branch's version, clients check to be notified of new versions. This can potentially be replaced with the `stable` branch's version,
@ -70,7 +70,8 @@ In all cases the branch should be named as per the scheme `<class>/<issue number
* `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. * `<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.
* `<title>` is intended to allow anyone to quickly know what the branch is addressing. Try to choose something * `<title>` is intended to allow anyone to quickly know what the branch is addressing. Try to choose something
succinct for `<title>`, it's just there for easy reference, it doesn't need to be the entire title of succinct for `<title>`, it's just there for easy reference, it doesn't need to be the entire title of
the appropriate issue. the appropriate issue.