Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
[DEL] moving git commit message manners to code of conduct
  • Loading branch information
meudnaes authored Jun 25, 2024
1 parent f035be7 commit 0a6e069
Showing 1 changed file with 0 additions and 27 deletions.
27 changes: 0 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,30 +63,3 @@ bx = get_var(brxp, snap, "bx"; units="si", destagger=true)
will load the $x$-component of the magnetic field in SI units and destagger it to the cell center.

See the [documentation](https://ITA-Solar.github.io/BifrostTools.jl/dev/) for further information and more elaborate example usage.

___
### Git commit message manners
The commit message is mainly for other people, so they should be able to understand it now and six months later. Commit messages cannot be longer than one sentence (line) and should start with a tag identifier (see the end of this section).

Use the imperative form of verbs rather than past tense when referring to changes introduced by the commit in question. For example, "Remove property X", not "Removed property X" and not "I removed...". This tense makes picking, reviewing or reverting commits more readable.

Use following tags for commit messages:

[DEV] : Code development (including additions and deletions)
[ADD] : Adding new feature
[DEL] : Removing files, routines
[FIX] : Fixes that occur during development, but which have essentially no impact on previous work
[BUG] : Bug with significant impact on previous work -- `grep`-ing should give restricted list
[OPT] : Optimisation
[DBG] : Debugging
[ORG] : Organisational, no changes to functionality
[SYN] : Typos and misspellings (including simple syntax error fixes)
[DOC] : Documentation only
[REP] : Repository related changes (e.g., changes in the ignore list, remove files)
[UTL] : Changes in utils

Commit message examples:

* "[BUG] Add missing initialisation to tg array"
* "[FIX] Add lowercase castig to params"
* "[CLN] Remove unnecessary allocation for dynamic arrays."

0 comments on commit 0a6e069

Please sign in to comment.