|
| 1 | +# Contributing to IntegerNet_SessionUnblocker |
| 2 | +We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: |
| 3 | + |
| 4 | +- Reporting a bug |
| 5 | +- Discussing the current state of the code |
| 6 | +- Submitting a fix |
| 7 | +- Proposing new features |
| 8 | +- Becoming a maintainer |
| 9 | + |
| 10 | +## We Develop with Github |
| 11 | +We use github to host code, to track issues and feature requests, as well as accept pull requests. |
| 12 | + |
| 13 | +## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests |
| 14 | +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: |
| 15 | + |
| 16 | +1. Fork the repo and create your branch from `master`. |
| 17 | +2. If you've added code that should be tested, add tests. |
| 18 | +3. If you've changed APIs, update the documentation. |
| 19 | +4. Ensure the test suite passes. |
| 20 | +5. Make sure your code lints. |
| 21 | +6. Issue that pull request! |
| 22 | + |
| 23 | +## Any contributions you make will be under the MIT Software License |
| 24 | +In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern. |
| 25 | + |
| 26 | +## Report bugs using Github's [issues](https://github.com/integer-net/magento2-session-unblocker/issues) |
| 27 | +We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/integer-net/magento2-session-unblocker/issues/new); it's that easy! |
| 28 | + |
| 29 | +## Write bug reports with detail, background, and sample code |
| 30 | +[This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report I wrote, and I think it's not a bad model. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408), an app developer whom I greatly respect. |
| 31 | + |
| 32 | +**Great Bug Reports** tend to have: |
| 33 | + |
| 34 | +- A quick summary and/or background |
| 35 | +- Steps to reproduce |
| 36 | + - Be specific! |
| 37 | + - Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that *anyone* with a base R setup can run to reproduce what I was seeing |
| 38 | +- What you expected would happen |
| 39 | +- What actually happens |
| 40 | +- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) |
| 41 | + |
| 42 | +People *love* thorough bug reports. I'm not even kidding. |
| 43 | + |
| 44 | +## Pull Requests |
| 45 | + |
| 46 | +- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - Check the code style with ``$ composer check-style`` and fix it with ``$ composer fix-style``. |
| 47 | + |
| 48 | +- **Add tests!** - Your patch won't be accepted if it doesn't have tests. |
| 49 | + |
| 50 | +- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date. |
| 51 | + |
| 52 | +- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option. |
| 53 | + |
| 54 | +- **Create feature branches** - Don't ask us to pull from your master branch. |
| 55 | + |
| 56 | +- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. |
| 57 | + |
| 58 | +- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting. |
| 59 | + |
| 60 | +## License |
| 61 | +By contributing, you agree that your contributions will be licensed under its MIT License. |
| 62 | + |
| 63 | +## References |
| 64 | +This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md) with additions from [ThePhpLeague Template](https://github.com/thephpleague/skeleton) |
0 commit comments