Mercurial > repos > public > sbplib_julia
comparison WORKFLOW.md @ 1888:eb70a0941cd6 allocation_testing
Merge default
| author | Jonatan Werpers <jonatan@werpers.com> |
|---|---|
| date | Fri, 03 Feb 2023 23:02:46 +0100 |
| parents | 48cbcbc7a40b |
| children |
comparison
equal
deleted
inserted
replaced
| 1887:24590890e124 | 1888:eb70a0941cd6 |
|---|---|
| 1 # Branch model | |
| 2 | |
| 3 The `default` branch contains stable code and the goal is that all tests should be passing on this branch. Version of the code are marked with mercurial tags. Changes in the code are developed in named branches which are closed and merged into `default` when the code is ready. During development merging `default` into the development branch is encouraged to avoid complicated conflicts. | |
| 4 | |
| 5 Branches are named using slash separated keywords. The first keyword describes the type of change being pursued in the branch. Important type keywords are | |
| 6 * feature | |
| 7 * bugfix | |
| 8 * refactor | |
| 9 Further keywords may describe where, e.g. what sub package, the change happens. The last keyword should describe the change. | |
| 10 | |
| 11 Some examples: | |
| 12 * refactor/grids: Branch to refactor the grids module | |
| 13 * bugfix/lazy_tensors/lazyfunctionarray: Branch to fix a bug in LazyFunctionArray | |
| 14 | |
| 15 ## Merging a branch into `default` | |
| 16 The changes in a branch has been reviewed and deemed ready to merge the branch is closed and then merged. | |
| 17 | |
| 18 Before merging a development branch, `default` should be merge into the development branch to make sure the whole state of the code is reviewed and tested before it ends up on `default`. | |
| 19 | |
| 20 With the development branch active the following commands can be used to complete the merging of a development branch. | |
| 21 ```shell | |
| 22 hg merge default | |
| 23 hg commit --close-branch -m "Close before merge" | |
| 24 hg update default | |
| 25 hg merge development/branch | |
| 26 hg commit -m "Merge development/branch" | |
| 27 ``` | |
| 28 | |
| 29 # Review | |
| 30 | |
| 31 ## Checklist for review | |
| 32 * Push and pull new changes | |
| 33 * Search and check TODOs | |
| 34 * Search and check TBDs | |
| 35 * Search and check REVIEWs | |
| 36 * Review code | |
| 37 * Review tests | |
| 38 * Review docstrings | |
| 39 * Render Documenter and check docstrings in browser | |
| 40 * Run full tests | |
| 41 | |
| 42 # Special comments | |
| 43 The following special comments are used: | |
| 44 * `# TODO: `: Something that should be done at some point. | |
| 45 * `# TBD: `: "To be determined", i.e a decision that has to be made. | |
| 46 * `# REVIEW: `: A review comment. Should only exist on development branches. |