Skip to content
Snippets Groups Projects
Commit beb50819 authored by Benjamin Schwenker's avatar Benjamin Schwenker
Browse files

Update CONTRIBUTING.md

parent 02091276
Branches main
Tags v0.4.0
1 merge request!62Update CONTRIBUTING.md
......@@ -2,27 +2,29 @@
Thank you for investing your time in contributing to our project!
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
In this guide you will get an overview of the contribution workflow from opening an issue, creating a merge request, reviewing
and merging into the master branch.
## Issues
If you find a problem or have a suggestion, please search for a related issue on the BGNet issue tracker. If you cannot find an existing
issue, please create a new one. Give a descriptive name to the issue and provide a clear description.
If you find a problem or have a suggestion, please search for a related issue on the BGNet issue tracker. If you cannot find an existing
issue, please create a new one. Give a descriptive name to the issue and provide a clear description.
## Commit your update
Create a new branch, implement your changes and do not forget to self review them.
Create a new branch from the drop down menu of your issue, implement your changes and do not forget to self review them.
## Pull Request
## Merge Request
When you're finished with the changes, create a pull request, also known as a PR.
When you're finished with the changes, create a merge request.
- Give a descriptive name
- Merge into the master branch
- Link to the pull request your issue
- Give a descriptive name (typically the name of the issue from which you created the brach)
- Merge into the master branch
- Add benjamin.schwenker as reviewer
## Your PR is merged!
The master branch is used as the production branch and is protected.
## Your request is merged!
Congratulation!
......@@ -30,10 +32,10 @@ Congratulation!
MIT, see [LICENSE](LICENSE).
## Contributors
## Contributors
The following people have contributed to the development of BGNet:
-benjamin.schwenker@phys.uni-goettingen.de
-yannik.buch@desy.de
-lukas.herzberg@desy.de
- benjamin.schwenker@phys.uni-goettingen.de
- yannik.buch@desy.de
- lukas.herzberg@desy.de
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment