Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from zomry1/Contirbute
π₯ add CONTRIBUTING
- Loading branch information
Showing
1 changed file
with
38 additions
and
0 deletions.
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 |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Contributing to Hystrix-Box | ||
ππ First off, thanks for taking the time to contribute! ππ | ||
We want to make contributing to this project as easy and transparent as possible, whether it's: | ||
|
||
## How Can I Contribute? | ||
- Reporting a bug | ||
- Submitting a fix | ||
- Proposing new features | ||
- Becoming a maintainer | ||
|
||
|
||
## Reporting a bug π | ||
Open a new issue using the bug report [template](https://github.com/zomry1/Hystrix-Box/issues/new?assignees=&labels=&template=bug_report.md&title=) | ||
|
||
### We Develop with Github | ||
We use github to host code, to track issues and feature requests, as well as accept pull requests. | ||
|
||
### We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests | ||
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests: | ||
|
||
## Code contribute method | ||
1. π¦ Open new issue and get the green light to start working on the code (This is an important stage, in order to avoid unnecessary work). | ||
2. π΄ Fork the repo and create your branch from `dev` (Give it a self-explain name). | ||
3. π¬ Commit your code once in a while to help other developers understand you work (Use good commit messages). | ||
* We are using emojis to define commits using [this guide](https://github.com/dannyfritz/commit-message-emoji) | ||
4. π If you've added code that should be tested, add tests. | ||
5. π If you've changed APIs, update the documentation. | ||
6. β Ensure the test suite passes. | ||
7. π Issue that pull request! (And use the pull request template) | ||
8. π Get our sincere appreciation! | ||
|
||
* steps 4,5 are optional, you can leave those to the maintainers, but update us about that. | ||
|
||
## Report bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues) | ||
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy! | ||
|
||
## License | ||
By contributing, you agree that your contributions will be licensed under its MIT License. |