Skip to content

Commit

Permalink
code of conduct, contributing template
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronmussig committed Aug 2, 2020
1 parent 2eb18ec commit 71eef49
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 2 deletions.
File renamed without changes.
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
## How to contribute to GTDB-Tk

GTDB-Tk follows [GitHub flow](https://guides.github.com/introduction/flow/index.html),
i.e. all changes must come through a pull request.

#### Step 1: Creating an issue
Firstly, check to see if the issue has already been opened or discussed. If not,
create the issue. This gives everybody full visibility of the proposed changes you wish to make
and a discussion can take place.

This is a very good idea to make sure that there are no upcoming changes that conflict
with your proposed changes.

#### Step 2: Fork the repository and create a new branch
After forking the repository, you should create a new branch based on the `staging` branch that
references your issue.

#### Step 3: Development
Try follow the current coding style as closely as possible. Please try and make sure there are unit
tests where applicable.

#### Step 4: Create a pull request
If you a only wish to discuss your code, open a draft pull request to the `staging` branch.

Otherwise, ensure that all unit tests are passing and open the pull request to the `staging` branch.

#### Step 5: Review and merge
After your code has been reviewed it will be merged into the `staging` branch for the next release.

---

**Thanks!** _- the GTDB-Tk contributors_
2 changes: 0 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# Note: Only GitHub pages in hosted on this branch, for everything else check `stable`

https://ecogenomics.github.io/GTDBTk/

0 comments on commit 71eef49

Please sign in to comment.