From c33f7cfd414037d13b8290cb4111e0c1cce2d345 Mon Sep 17 00:00:00 2001 From: Timo Koch <timo.koch@iws.uni-stuttgart.de> Date: Wed, 25 Jul 2018 12:21:45 +0200 Subject: [PATCH] [contributing] Update preliminary contribution guidelines --- CONTRIBUTING.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0d94da97bd..62dcd08519 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,3 +2,32 @@ ## Style guide When contributing code to DuMu<sup>x</sup> please follow the [styleguide](doc/styleguide.md). + +## Git +* Everything should compile after every single commit +* Make small commits with changes limited to a single issue / change +* Format commit messages as follows +``` +[topic] Brief description of the change + +Long description containing the status quo, +the changes the commit introduces and why. +``` +where `topic` is usually a foldername, `[assembly]`, a model `[2p2c]`, or any other topic, e.g. `[cmake]`. + +* Use `git rebase -i master` to update branches to the changes on the master branch + +## GitLab +* open issues for bugs / discussions / feature requests +* give issues a meaningful title, focus each issue on a single topic, describe what the problem is and what you tried +* open merge request for changes to be merged into master or other branches. Pushing to master is disabled. +* give merge requests a meaningful title, describe what the problem is, how this is fixed with this merge request +* if you don't have the permissions to open branches, you might have permissions to do a fork in your own GitLab namespace and open a merge request from your fork into the dumux repository. +* merge requests get reviewed by at least one main developer +* if continuous integration (GitLabCI / BuildBot) is enabled for merge requests, the pipeline has to pass before merging anything to master + +## Patches + +* Patches can be supplied via the mailing list +* Should be formatted with git format-patch +* TODO: How to format patches -- GitLab