Skip to content
This repository has been archived by the owner on May 6, 2024. It is now read-only.

Commit

Permalink
clarify/update some of the git usage docs
Browse files Browse the repository at this point in the history
(which are mainly for unexperienced coworkers;-)
  • Loading branch information
jokuha committed Apr 20, 2020
1 parent 76fdc7f commit 587f8dc
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions doc/developer-guide.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
CMIstark developer guide
===========================
========================

Here are a few simple guidelines to please be obeyed when working on CMIdiffract

Expand All @@ -25,33 +25,31 @@ Source code formatting
Version control (git) details
-----------------------------

* CMIstark uses git (Stash) as a version control system with a central repositories in the
DESY-CFEL-CMI stash server.
* CMIstark uses git as a version control system with a central repositories on github_.

* CMIstark uses the git-flow branching model

* the principal development branch is ``develop``
* all new developments should be done on a ``feature/`` branch and, once ready, be branched into
``develop``
``develop``

* never touch the branch ``master`` -- this is to be done by the maintainers.

* the ``master`` branch is only for releases, which for CMIstark are rare and surely only after
discussion with me. There should never be any development done on ``master``, nor any release
preparations. The latter is done on ``release/``, then the release is put onto ``master``, and
possibly necessary fixes are done on ``hotfix/``!
* the ``master`` branch is only for releases. There should never be any development done on
``master``, nor any release preparations. The latter is done on ``release/``, then the release
is put onto ``master``, and possibly necessary fixes are done on ``hotfix/``.

* Do not repeatedly branch feature branches into ``develop`` instead merge ``develop`` into your
``feature/`` branch.

* General documentation work should always be made on ``develop`` (only)!

* commit such doc-only updates as separate commits!
* one can then merge these doc-only commits into ``feature/`` branches

* **never implement a change twice** manually! Implement it on the most appropriate branch, then merge
it into whatever branch you want to have it!
* **never implement a change twice** manually. Implement it on the most appropriate branch, then
merge it into whatever branch you want to have it.

* make sure the git repo stays clean and one can follow it with our turning crazy!


State labels of stored Stark curves
Expand Down Expand Up @@ -137,6 +135,9 @@ folder are as follows:
- ``util.py``: provide array operations


.. _github: https://github.com/CFEL-CMI/cmistark


.. comment
Local Variables:
coding: utf-8
Expand Down

0 comments on commit 587f8dc

Please sign in to comment.