diff options
author | Karl Berry <karl@freefriends.org> | 2019-12-23 21:34:59 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2019-12-23 21:34:59 +0000 |
commit | fcc8dc3639bfad877fe91e5ede926aa8f8a2af1e (patch) | |
tree | e8442d052e61249d9eb47d91e002609b1e9e2d98 /Master/texmf-dist/doc/latex/europecv/CONTRIBUTING.md | |
parent | c3e39e899206e8fa4dc6636f5e90c1f568634428 (diff) |
europecv (23dec19)
git-svn-id: svn://tug.org/texlive/trunk@53217 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/europecv/CONTRIBUTING.md')
-rw-r--r-- | Master/texmf-dist/doc/latex/europecv/CONTRIBUTING.md | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/europecv/CONTRIBUTING.md b/Master/texmf-dist/doc/latex/europecv/CONTRIBUTING.md index 1b8e73d7c21..a750e77578d 100644 --- a/Master/texmf-dist/doc/latex/europecv/CONTRIBUTING.md +++ b/Master/texmf-dist/doc/latex/europecv/CONTRIBUTING.md @@ -47,4 +47,66 @@ There is some basic requirement for us to merge a pull request: In your code: - Make sure the coding style of your code follows the style of the file. + +## Workflow + +### Stable branch: `master` + +The `master` branch is stable and **should not receive new features**. Only **bug fixes** are accepted. + +This is the typical workflow to fix a bug in the master branch. + +* Identify a bug that does not require breaking changes of the API/ABI. +* Open an issue on github. +* Add some label (FIXME which label?). +* Assign the issue to yourself. +* Create a new branch starting from the `master` branch: + +``` +git fetch origin +git checkout -b <branch_name> origin/master +``` + +* Fix the bug and make one or more commits. +* [Push the branch on your fork and create a pull request](https://help.github.com/categories/collaborating-on-projects-using-pull-requests/). +* Wait for someone else to review your fix and merge your pull request. +* Your fix is now in the `master` branch, now you need to port it to the `devel` + branch. +* Ensure that your branches are in sync with `origin`: + +``` +git checkout master +git pull --rebase origin master +git checkout devel +git pull --rebase origin devel +``` + + * Merge master into devel and eventually fix the conflicts. + +``` +git merge master +``` + +##### Work in progress PR +As final note, in case you need to start a PR but you deem it still **work-in-progress** and don't want anyone to merge it by mistake, do the following: +- Put `[WIP]` at the beginning of the PR title. +- Mark the PR with the label `"Status: In Progress"`. + +Once you're happy about your work, just remove the `[WIP]` tag as well as the label, and drop a message within the PR to notify the community that reviews are welcome and merging is now possible. + +### Development branch: `dev` + + +We use the branch `dev` to collect the ongoing work, which is given in terms of **new features** and **bug fixes**. + +When we introduce a new feature that will cause downstream projects to be aware of such update, we do increase the tweak number (always sticking to _odd numbers_). + +When we decide to publish these new features in a new software release (roughly each _3 months_), we merge the new modifications into `master`, doing: + +```sh +git checkout master +git merge --no-ff devel +git push origin master +``` + |