Merge pull request #201 from icecube/fix198

Fixes #198 issue by adding guidelines to the docs for the development process

README.md

@@ -6,7 +6,11 @@
 
 [[Full documentation]](https://icecube.github.io/skyllh/).
 
-The SkyLLH framework is an open-source Python3-based package licensed under the GPLv3 license. It provides a modular framework for implementing custom likelihood functions and executing log-likelihood ratio hypothesis tests. The idea is to provide a class structure tied to the mathematical objects of the likelihood functions, rather than to entire abstract likelihood models.
+The SkyLLH framework is an open-source Python3-based package licensed under the
+GPLv3 license. It provides a modular framework for implementing custom
+likelihood functions and executing log-likelihood ratio hypothesis tests.
+The idea is to provide a class structure tied to the mathematical objects of the
+likelihood functions, rather than to entire abstract likelihood models.
 
 The math formalism used in SkyLLH is described in the
 [[math formalism document]](https://github.com/icecube/skyllh/blob/master/doc/user_manual.pdf).
@@ -15,7 +19,8 @@ The math formalism used in SkyLLH is described in the
 
 ## Using pip
 
-The latest `skyllh` release can be installed from [PyPI](https://pypi.org/project/skyllh/) repository:
+The latest `skyllh` release can be installed from
+[PyPI](https://pypi.org/project/skyllh/) repository:
 ```bash
 pip install skyllh
 ```
@@ -25,17 +30,20 @@ The current development version can be installed using pip:
 pip install git+https://github.com/icecube/skyllh.git#egg=skyllh
 ```
 
-Optionally, the editable package version with a specified reference can be installed by:
+Optionally, the editable package version with a specified reference can be
+installed by:
 ```bash
 pip install -e git+https://github.com/icecube/skyllh.git@[ref]#egg=skyllh
 ```
 where
 - `-e` is an editable flag
-- `[ref]` is an optional argument containing a specific commit hash, branch name or tag
+- `[ref]` is an optional argument containing a specific commit hash, branch name
+  or tag
 
 ## Cloning from GitHub
 
-The `skyllh` (and an optional private [i3skyllh](#i3skyllh)) package can be installed by cloning the GitHub repository and adding it to the Python path:
+The `skyllh` (and an optional private [i3skyllh](#i3skyllh)) package can be
+installed by cloning the GitHub repository and adding it to the Python path:
 
 ```python
 import sys
@@ -48,11 +56,55 @@ sys.path.insert(0, '/path/to/i3skyllh')  # optional
 
 Several publications about the SkyLLH software are available:
 
+- IceCube Collaboration, C. Bellenghi, M. Karl, M. Wolf, et al. PoS ICRC2023 (2023) 1061
+  [DOI](https://doi.org/10.22323/1.444.1061)
 - IceCube Collaboration, T. Kontrimas, M. Wolf, et al. PoS ICRC2021 (2022) 1073
   [DOI](http://doi.org/10.22323/1.395.1073)
 - IceCube Collaboration, M. Wolf, et al. PoS ICRC2019 (2020) 1035
   [DOI](https://doi.org/10.22323/1.358.1035)
 
+# Developer Guidelines
+
+These guidelines should help new developers of SkyLLH to join the development
+process easily.
+
+## Code style
+
+- The code follows PEP8 coding style guidelines as close as possible.
+
+- Code lines are maximum 80 characters wide.
+
+- 4 spaces are used as one indentation level.
+
+## Branching
+
+- When implementing a new feature / change, first an issue must be created
+  describing the new feature / change. Then a branch must be created referring
+  to this issue. We recommend the branch name `fix<ISSUE_NUMBER>`, where
+  `<ISSUE_NUMBER>` is the number of the created issue for this feature / change.
+
+- In cases when SkyLLH needs to be updated because of a change in the i3skyllh
+  package (see below), we recommend the branch name `i3skyllh_<ISSUE_NUMBER>`,
+  where `<ISSUE_NUMBER>` is the number of the issue created in the i3skyllh
+  repository. That way the *analysis unit tests* workflow will be able to find
+  the correct skyllh branch corresponding to the i3skyllh change automatically.
+
+## Releases and Versioning
+
+- Release version numbers follow the format `v<YY>.<MAJOR>.<MINOR>`, where
+  `<YY>` is the current year, `<MAJOR>` and `<MINOR>` are the major and minor
+  version numbers of type integer. Example: `v23.2.0`.
+
+- Release candidates follow the same format as releases, but have the additional
+  suffix `.rc<NUMBER>`,  where `<NUMBER>` is an integer starting with 1.
+  Example: `v23.2.0.rc1`
+
+- Before creating the release on github, the version number needs to be updated
+  in the Sphinx documentation: `doc/sphinx/conf.py`.
+
 # i3skyllh
 
-The [`i3skyllh`](https://github.com/icecube/i3skyllh) package provides complementary pre-defined common analyses and datasets for the [IceCube Neutrino Observatory](https://icecube.wisc.edu) detector in a private [repository](https://github.com/icecube/i3skyllh).
+The [`i3skyllh`](https://github.com/icecube/i3skyllh) package provides
+complementary pre-defined common analyses and datasets for the
+[IceCube Neutrino Observatory](https://icecube.wisc.edu) detector in a private
+[repository](https://github.com/icecube/i3skyllh).