Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
OrcaSong
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Machine Learning
OrcaSong
Commits
14090998
Commit
14090998
authored
6 years ago
by
ViaFerrata
Browse files
Options
Downloads
Patches
Plain Diff
Minor docs changes.
parent
d0f7f2ab
No related branches found
No related tags found
No related merge requests found
Changes
2
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
docs/CONTRIBUTING.rst
+85
-0
85 additions, 0 deletions
docs/CONTRIBUTING.rst
docs/index.rst
+1
-1
1 addition, 1 deletion
docs/index.rst
with
86 additions
and
1 deletion
docs/CONTRIBUTING.rst
0 → 100644
+
85
−
0
View file @
14090998
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.
This diff is collapsed.
Click to expand it.
docs/index.rst
+
1
−
1
View file @
14090998
...
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment