From 0a6e0691ea9aa01a4bf63eba8f2be25f19bbdd8d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Elias=20Udn=C3=A6s?= <32062398+meudnaes@users.noreply.github.com> Date: Tue, 25 Jun 2024 10:17:11 +0200 Subject: [PATCH] Update README.md [DEL] moving git commit message manners to code of conduct --- README.md | 27 --------------------------- 1 file changed, 27 deletions(-) diff --git a/README.md b/README.md index 88d559d..d30759c 100644 --- a/README.md +++ b/README.md @@ -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."