diff --git a/docs/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst new file mode 100644 index 0000000000000000000000000000000000000000..fbb9a460d120c567ba63c00ed0e2606edf439357 --- /dev/null +++ b/docs/CONTRIBUTING.rst @@ -0,0 +1,85 @@ +Contributing +============ +.. contents:: :local: + +Contact Us +---------- +Join the Deep Learning channel here: https://chat.km3net.de/channel/deep_learning + +Filing Bugs or Feature Requests +------------------------------- + +Please **always** create an issue when you encounter any bugs, problems or +need a new feature. Emails and private messages are not meant to communicate +such things! + +Use the appropriate template and file a new issue here: +https://git.km3net.de/ml/OrcaSong/issues + +If you're not in the KM3NeT collaboration, please open an issue on github: +https://github.com/ViaFerrata/OrcaSong/issues + +Please follow the instructions in the templates to provide all the +necessary information which will help other people to understand the +situation. + +Make a Fork of OrcaNet +---------------------- + +You create a fork (your full own copy of the +repository), change the code and when you are happy with the changes, you create +a merge request, so we can review, discuss and add your contribution. +Merge requests are automatically tested on our GitLab CI server and you +don't have to do anything special. + +Go to http://git.km3net.de/ml/OrcaSong and click on "Fork". + +After that, you will have a full copy of OrcaNet with write access under an URL +like this: ``http://git.km3net.de/your_git_username/OrcaSong`` + +Clone your Fork to your PC +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Get a local copy to work on (use the SSH address `git@git...`, not the HTTP one):: + + git clone git@git.km3net.de:your_git_username/OrcaSong.git + +Now you need to add a reference to the original repository, so you can sync your +own fork with the OrcaSong repository:: + + cd OrcaSong + git remote add upstream git@git.km3net.de:ml/OrcaSong.git + + +Keep your Fork Up to Date +~~~~~~~~~~~~~~~~~~~~~~~~~ + +To get the most recent commits (including all branches), run:: + + git fetch upstream + +This will download all the missing commits and branches which are now accessible +using the ``upstream/...`` prefix:: + + $ git fetch upstream + From git.km3net.de:ml/OrcaSong + * [new branch] branch1 -> upstream/branch1 + * [new branch] branch2 -> upstream/branch2 + + +If you want to update for example your **own** ``master`` branch +to contain all the changes on the official ``master`` branch of OrcaNet, +switch to it first with:: + + git checkout master + +and then merge the ``upstream/master`` into it:: + + git merge upstream/master + +Make sure to regularly ``git fetch upstream`` and merge changes to your own branches. + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +DISCLAIMER: This is totally copy & pasted & modified from the excellent km3pipe equivalent. diff --git a/docs/index.rst b/docs/index.rst index c6f65bf73869eeb06f74bc32ade5a37a0ef332f2..eaec1d855dd477afc6e1f8d3ee22cea45da08185 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -37,7 +37,7 @@ Please feel free to contact me or just open an issue on Gitlab / Github if you h :caption: Contents: getting_started - contributing_link + CONTRIBUTING Source (Git) <https://git.km3net.de/ml/OrcaSong.git> Indices and tables