Development

Jump to bottom

benedikt-voelkel edited this page Dec 17, 2018 · 14 revisions

Instructions for developers

If you want to contribute to this package, the workflow is basically the following

fork from the upstream (https://github.com/ginnocen/MachineLearningHEP)
create your development branch on your fork
do the development
make local validation tests (see [below](## Local validations))
if you are ready, create a pull request (PR) to upstream/dev

Commenting on PRs

From time to time it might make sense to have a look at open PRs. If you have an idea, comments etc. concerning a specific PR, comment on that.

Open an issue

There are different cases when opening an issue makes sense and can be done here, e.g.:

you found a bug: make clear where the bug is and when/how it emerges. If you have suggestions, dump these as well.
you have an idea for a major upgrade: in case you have a nice idea for a very nice enhancement, tell what you think. This helps in case you don't have time to do the development yourself or you are not directly in charge for a certain part of the code.

In the end, add corresponding labels to your issue for a better overview and refer to issues, code other PRs whenever useful.

Local validations