Commit 969b7303 authored by Jure's avatar Jure
Browse files

docs: update contributing guide

parent 952c56be
CONTRIBUTING # CONTRIBUTING
Branches PubSweet is both an open source software project (https://gitlab.coko.foundation/pubsweet/pubsweet) and an open community, part of the broader Collaborative Knowledge Foundation (https://coko.foundation/) (Coko) community. We welcome people of all kinds to join the community and contribute with knowledge, skills, expertise. Everyone is welcome in our chat room (https://mattermost.coko.foundation/coko/channels/town-square).
In order to contribute to PubSweet,you're expected to follow a few sensible guidelines.
## Search first, ask questions later
If you want to create a new component or if you've experienced a bug or want to discuss something in the issue trackers, please search before you start developing to find out whether it already exists.
## Discuss your contribution before you build
Please let us know about the contribution you plan to make before you start it. Either comment on a relevant existing issue, or open a new issue if you can't find an existing one. This helps us avoid duplicating effort and to ensure contributions are likely to be accepted. You can also ask in the chat room (https://mattermost.coko.foundation/coko/channels/pubsweet) if you are unsure.
For contributions made as discussions and suggestions, you can at any time open an RFC in our issue tracker and PubSweet community members will be happy to jump into a discussion.
## Branches
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: 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:
create a user account on Coko GitLab : http://gitlab.coko.foundation create a user account on Coko GitLab : http://gitlab.coko.foundation
Clone master with git clone git@gitlab.coko.foundation:pubsweet/pubsweet.git Clone master with git clone git@gitlab.coko.foundation:pubsweet/pubsweet.git
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. 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.
Getting your contributions merged ## Getting your contributions merged
This is a two part process, first ask for comments, then ask for the changes to be merged. This is a two part process, first ask for comments, then ask for the changes to be merged.
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 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
...@@ -18,15 +32,15 @@ We encourage feedback and discussion from as many people as possible on Merge Re ...@@ -18,15 +32,15 @@ We encourage feedback and discussion from as many people as possible on Merge Re
Before merging all PRs must fulfill these three simple rules: Before merging all PRs must fulfill these three simple rules:
1. Before a PR can be merged, it must pass the tests and CI. 1. Before a PR can be merged, it must pass the tests and CI.
2. Before a PR can be merged, it shouldn't reduce the test coverage. 2. Before a PR can be merged, it shouldn't reduce the test coverage.
3. Bugfixes go in PRs and a bugfix PR shouldn't be merged without a regression test. 3. Bugfixes go in PRs and a bugfix PR shouldn't be merged without a regression test.
Conventional commits ## Conventional commits
We use conventional commits and verify that commit messages match the pattern, you can read more about it here: https://conventionalcommits.org/ and here: https://github.com/conventional-changelog-archived-repos/conventional-changelog-angular/blob/master/convention.md. You can use `yarn cz` to use a command-line tool that helps you with formatting your commit. We use conventional commits so that we can automatically follow semantic versioning and generate CHANGELOGs across all packages. We use conventional commits and verify that commit messages match the pattern, you can read more about it here: https://conventionalcommits.org/ and here: https://github.com/conventional-changelog-archived-repos/conventional-changelog-angular/blob/master/convention.md. You can use `yarn cz` to use a command-line tool that helps you with formatting your commit. We use conventional commits so that we can automatically follow semantic versioning and generate CHANGELOGs across all packages.
Bug reports, feature requests, support questions ## Bug reports, feature requests, support questions
This is all done through GitLab using their native issue tracker This is all done through GitLab using their native issue tracker
Visit the master issue tracker for PubSweet (https://gitlab.coko.foundation/pubsweet/pubsweet/issues) Visit the master issue tracker for PubSweet (https://gitlab.coko.foundation/pubsweet/pubsweet/issues)
...@@ -35,4 +49,4 @@ Tag the issue with 'support', 'bug', or 'feature' to identify the nature of your ...@@ -35,4 +49,4 @@ Tag the issue with 'support', 'bug', or 'feature' to identify the nature of your
Releases - follow one simple rule: Releases - follow one simple rule:
1. Tests must pass. 1. Tests must pass.
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