-
Notifications
You must be signed in to change notification settings - Fork 229
Tags for commit messages and PR titles
Fabio Luporini edited this page Aug 2, 2022
·
10 revisions
Commit message format: <tag: message>
PR title format: <tag: title>
tag
should:
-
start with a lower case letter
-
be one of the following words:
- dsl: obv. Note: fd, differentiable, etc -- they all belong to dsl
- compiler: compilation (operator, ir, passes, symbolics, ...)
- arch: jit and architecture (basically anything in devito/arch)
- tests: obv
- examples: obv
- builtins: obv
- bench: anything related to benchmarking and profiling
- misc: tools, docstring/comment updates, pep8 fixups, etc
- ckp: Checkpointing related
- sympy: sympy-related patch
- ci: continuous integration-related
- reqs: package dependence updates
- install: related to installation (docker, conda, python ...)
message
should:
- start with an upper case letter
- start with a verb in first person
- be as short as possible
Examples:
compiler: Fix MPI optimization pass
install: Update Dockerfiles to new NVidia SDK