CONTRIBUTING.md 3.13 KB
Newer Older
Sidorela Uku's avatar
Sidorela Uku committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# CONTRIBUTING

NCBI is a web application built with [PubSweet](https://gitlab.coko.foundation/pubsweet/pubsweet) and is currently under development by [Coko Foundation](https://coko.foundation/)
We welcome people of all kinds to join the community and contribute with knowledge, skills, expertise. Everyone is welcome in our forum: https://discourse.coko.foundation/.

In order to contribute to NCBI, you're expected to follow a few sensible guidelines.

## 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](https://gitlab.coko.foundation/ncbi/ncbi/issues) if you can't find an existing one. This helps us avoid duplicating effort and to ensure contributions are likely to be accepted.

For contributions made as discussions and suggestions, you can at any time open an RFC (request for comments) in our issue tracker.

## Branches

We maintain master as the production branch and tag it with release names but we have also develop branch for developing. If you wish to contribute to NCBI then you need to make a branch from develop branch and then issue a pull request following this procedure:  
Create a user account on Coko's GitLab: http://gitlab.coko.foundation
Clone develop with `git clone git@gitlab.coko.foundation:ncbi/ncbi.git`  
Create a new branch and work off of that. Please name the branch which sensibly identifies the feature you are working on. You can push the branch to GitLab at anytime.

## Getting your contributions 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 UI on your branch.  
Look at the feedback and alter your branch as necessary.  
To merge with develop - generate a merge request (Pull Request). You do this from the Gitlab UI on your branch.  
We encourage feedback and discussion from as many people as possible on Merge Requests!

Before merging all PRs must fulfill these three simple rules:

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.
3.  Bugfixes go in PRs and a bugfix PR shouldn't be merged without a regression test.

## 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 a CHANGELOG.

## Bug reports, feature requests, support questions

This is all done through GitLab using their native issue tracker.  
Visit the master issue tracker for NCBI (https://gitlab.coko.foundation/ncbi/ncbi/issues)  
Tag the issue with 'support', 'bug', or 'feature' to identify the nature of your issue.