Commit 472c64f4 authored by Jens Kroeger's avatar Jens Kroeger
Browse files

Update CONTRIBUTING.md

parent 412b5526
Pipeline #1235981 passed with stages
in 20 minutes and 4 seconds
# How to contribute # How to contribute
Thanks for considering to contribute to Corryvreckan. Any type of merge request, ranging from small bugfixes, improvements to the documentation to entirely new functionality, is much appreciated. We, the maintainers, will try to our best to look carefully at every merge request. Thanks for considering to contribute to Corryvreckan. Any type of merge request, ranging from small bugfixes, improvements to the documentation to entirely new functionality, is much appreciated. We, the maintainers, will try to our best to look carefully at every merge request.
If you only want to submit an issue, that is also very welcome, please continue directly to the [issue tracker](https://gitlab.cern.ch/simonspa/corryvreckan/issues) to open a ticket. If you only want to submit an issue, that is also very welcome, please continue directly to the [issue tracker](https://gitlab.cern.ch/corryvreckan/corryvreckan/issues) to open a ticket.
The following is a set of guidelines that will help both you as submitter as well as us maintainers to make it as easy as possible to contribute changes. The following is a set of guidelines that will help both you as submitter as well as us maintainers to make it as easy as possible to contribute changes.
## Getting started ## Getting started
Please follow the next steps to setup your system for contributing. Note that these are slightly different from the normal installation instructions in the manual. Please follow the next steps to setup your system for contributing. Note that these are slightly different from the normal installation instructions in the manual.
1. Make sure you have an account on [Gitlab](gitlab.cern.ch) (restricted to CERN associates). 1. Make sure you have an account on [GitLab](https://gitlab.cern.ch/) (restricted to CERN associates).
2. Fork the repository by clicking on 'Fork' on the main [repository](https://gitlab.cern.ch/simonspa/corryvreckan). 2. Fork the repository by clicking on 'Fork' on the main [repository](https://gitlab.cern.ch/corryvreckan/corryvreckan).
3. Clone your local fork using `git clone https://gitlab.cern.ch/simonspa/corryvreckan.git` (when using HTTPS, this has to be changed accordingly for SSH or KRB5) 3. Clone your local fork using `git clone https://gitlab.cern.ch/corryvreckan/corryvreckan.git` (when using HTTPS, this has to be changed accordingly for SSH or KRB5)
4. Install the latest version of the *clang* package with the *clang-format* and *clang-tidy* programs. 4. Install the latest version of the *clang* package with the *clang-format* and *clang-tidy* programs.
5. Follow the build instructions using CMake explained in the User's manual. 5. Follow the build instructions using CMake explained in the User's manual.
...@@ -19,10 +19,10 @@ Now you can start making changes and adding new functionality to the code. ...@@ -19,10 +19,10 @@ Now you can start making changes and adding new functionality to the code.
1. Run `etc/git-hooks/install-hooks.sh` from the repository top folder to install the git-hook that automatically updates the format of the code to comply with the coding style. 1. Run `etc/git-hooks/install-hooks.sh` from the repository top folder to install the git-hook that automatically updates the format of the code to comply with the coding style.
2. Create a new branch from master with a description of the change using `git checkout -b my-new-branch-name`. 2. Create a new branch from master with a description of the change using `git checkout -b my-new-branch-name`.
3. Read the relevant sections in the User's manual before starting to make changes. 3. Read the relevant sections in the user manual before starting to make changes.
4. Implement the new code and frequently commit using `git commit -m 'my commit message'`. Please use descriptive messages explaining what changed. 4. Implement the new code and frequently commit using `git commit -m 'my commit message'`. Please use descriptive messages explaining what changed.
5. Push the code to your local mirror using `git push --set-upstream origin`. 5. Push the code to your local mirror using `git push --set-upstream origin`.
6. Retrieve the latest changes to the upstream master every now and then. To do this add the upstream version to your remotes using `git remote add upstream https://gitlab.cern.ch/simonspa/corryvreckan.git` (or the SSH or KRB5 version if preferred). This only has to be done once, the first time after cloning the repository. Afterwards you fetch the changes using `git fetch upstream`. Then you can add the change preferably using rebase with `git rebase upstream master`. If that causes problems you can use merge with `git merge upstream master`. 6. Retrieve the latest changes to the upstream master every now and then. To do this add the upstream version to your remotes using `git remote add upstream https://gitlab.cern.ch/corryvreckan/corryvreckan.git` (or the SSH or KRB5 version if preferred). This only has to be done once, the first time after cloning the repository. Afterwards you fetch the changes using `git fetch upstream`. Then you can add the change preferably using rebase with `git rebase upstream master`. If that causes problems you can use merge with `git merge upstream master`.
## Submitting a pull request ## Submitting a pull request
As soon as there exists something in your branch, a merge request can be opened on the main repository. Do not forget that it is not a problem to open a merge request for incomplete implementations. As soon as there exists something in your branch, a merge request can be opened on the main repository. Do not forget that it is not a problem to open a merge request for incomplete implementations.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment