-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated project contribution guidelines
- Loading branch information
Nick DiZazzo
committed
Mar 7, 2017
1 parent
d1e4c43
commit ed2fa30
Showing
1 changed file
with
40 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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_<##>_<description>`. | ||
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 |