CONTRIBUTING.md 1.44 KB
Newer Older
Adam Hyde's avatar
Adam Hyde committed
1 2
# CONTRIBUTING

Adam Hyde's avatar
Adam Hyde committed
3
## Branches
Adam Hyde's avatar
Adam Hyde committed
4 5 6 7 8
We maintain master as the production branch and tag it with release names. If you wish to contribute to PubSweet then you need to make a branch and then issue a pull request following this procedure:
1. create a user account on Coko GitLab : http://gitlab.coko.foundation
2. Clone master with ```git clone git@gitlab.coko.foundation:pubsweet/core.git```
3. Create a new branch and work off that. Please name the branch which sensibly identifies the feature you are working on. You can push the branch to Coko Gitlab at anytime.

Adam Hyde's avatar
Adam Hyde committed
9
## Getting your contributions merged
Adam Hyde's avatar
Adam Hyde committed
10 11 12 13 14 15 16
This is a two part process, first ask for comments, then ask for the changes to be merged.
1. Ask for feedback generate a Merge Request (Pull Request) from the gitlab interface but do not assign this request to anyone. You do this from the Gitlab UI on your branch.
2. Look at the feedback and alter your branch as necessary. 
3. To merge with master - generate a merge request (Pull Request) and assign to Jure Triglav. You do this from the Gitlab UI on your branch.

We encourage feedback and discussion from as many people as possible on Merge Requests!

Adam Hyde's avatar
Adam Hyde committed
17 18
## Bug reports, feature requests, support questions
This is all done through GitLab using their native issue tracker
Adam Hyde's avatar
Adam Hyde committed
19 20
1. Visit the master issue tracker for PubSweet (https://gitlab.coko.foundation/pubsweet/core/issues)
2. Add an issue 
Adam Hyde's avatar
Adam Hyde committed
21
3. Tag the issue with 'support', 'bug', or 'feature' to identify the nature of your issue