neale/moth
neale
/
moth
mirror of https://github.com/dirtbags/moth.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Switch git workflow, 

I kept checking in to master,
so I made "check in to master" okay again.
Sorry, John.
This commit is contained in:
Neale Pickett 2020-09-18 14:41:28 -06:00
parent 8ed10a67c5
commit c52f15f55b
2 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -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).

12
docs/CONTRIBUTING.md
View File

@ -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.