From ed2fa30226085a75f287616ee2309d96f06139c5 Mon Sep 17 00:00:00 2001 From: Nick DiZazzo Date: Tue, 7 Mar 2017 13:44:47 -0500 Subject: [PATCH] Updated project contribution guidelines --- CONTRIBUTING.md | 41 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 40 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 088292c..99978b2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1 +1,40 @@ -aosndia +# How to contribute + +## Project organization + +* Branch `master` is always stable and release-ready. +* Branch `develop` is for development and merged into `master` when stable. +* Feature branches should be created for adding new features and merged into `develop` when ready. +* Bug fix branches should be created for fixing bugs and merged into `develop` when ready. +* See also: [*A successful Git branching model*](http://nvie.com/posts/a-successful-git-branching-model). + +## Opening a new issue + +**Do not open a duplicate issue!** + +1. Look through existing issues to see if your issue already exists. +2. If your issue already exists, comment on its thread with any information you have. Even if this is simply to note that you are having the same problem, it is still helpful! +3. Always *be as descriptive as you can*. +4. What is the expected behavior? What is the actual behavior? What are the steps to reproduce? +5. Attach screenshots, videos, GIFs if possible. +6. **Include Biome version or branch experiencing the issue.** +7. **Include platform version and devices experiencing the issue.** + +## Submitting a pull request + +1. Find an issue to work on, or create a new one. *Avoid duplicates, please check existing issues!* +2. Fork the repo, or make sure you are synced with the latest changes on `develop`. +3. Create a new branch with a name: `git checkout -b issue_<##>_`. +4. Do some work on it. +5. Write [unit tests](http://nshipster.com/unit-testing) when applicable. +6. Keep your code nice and clean. +7. Don't break unit tests or functionality. +8. Update the documentation header comments if needed. +9. **Rebase on `develop` branch and resolve any conflicts _before submitting a pull request!_** +10. Submit a pull request to the `develop` branch. + +**You should submit one pull request per feature!** The smaller the PR, the better your chances are of getting merged. Enormous PRs will likely take enormous amounts of time to review, or they will be rejected. + +## Callouts + +These contibution guidelines are originally based on https://github.com/jessesquires/HowToContribute/blob/master/README.md \ No newline at end of file