diff --git a/README.md b/README.md index 2a3b742..71deaa9 100644 --- a/README.md +++ b/README.md @@ -53,4 +53,4 @@ Inside the container, you need the following paths: Contributing to MOTH ================== -Please read [CONTRIBUTING.md](CONTRIBUTING.md) +Please read our [contributing guide](docs/CONTRIBUTING.md). diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 12867f4..cd51a78 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -9,11 +9,15 @@ We love your input! We want to make contributing to this project as easy and tra ## We Develop with Github We use github to host code, to track issues and feature requests, as well as accept pull requests. -## We Use [Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow), So All Code Changes Happen Through Pull Requests -Pull requests are the best way to propose changes to the codebase (we use [Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)). We actively welcome your pull requests: +## We Use the Feature Branch Workflow -1. Fork the repo and create your branch from `master`. -2. If you've added code that should be tested, add tests. +We use the [Feature Branch Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow). + +Pull requests are the best way to propose changes to the codebase. +We actively welcome your pull requests: + +1. Fork the repo. Optionally create a branch from `master`. +2. If you've changed code, modify tests that fail on the old code, and pass on the new code. 3. If you've changed APIs, update the documentation. 4. Ensure the test suite passes. 5. Make sure your code lints.