Skip to content

Commit

Permalink
Merge pull request #4 from zomry1/Contirbute
Browse files Browse the repository at this point in the history
πŸ‘₯ add CONTRIBUTING
  • Loading branch information
Mattssu committed Apr 20, 2020
2 parents 5b31270 + fe9c978 commit 6d30c07
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
@@ -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.

0 comments on commit 6d30c07

Please sign in to comment.