| 1 | # How to contribute
|
| 2 |
|
| 3 | We love you to contribute to this project by filing bugs or helping others on the [issue tracker](https://github.com/Nikku/karma-browserify/issues) or by contributing features/bug fixes through pull requests.
|
| 4 |
|
| 5 | ## Working with issues
|
| 6 |
|
| 7 | We use our [issue tracker](https://github.com/Nikku/karma-browserify/issues) for project communication.
|
| 8 | When using the issue tracker,
|
| 9 |
|
| 10 | * Be descriptive when creating an issue (what, where, when and how does a problem pop up)?
|
| 11 | * Attach steps to reproduce (if applicable)
|
| 12 | * Attach code samples, configuration options or stack traces that may indicate a problem
|
| 13 | * Be helpful and respect others when commenting
|
| 14 |
|
| 15 | Create a pull request if you would like to have an in-depth discussion about some piece of code.
|
| 16 |
|
| 17 | ## Creating pull requests
|
| 18 |
|
| 19 | We use pull requests for feature discussion and bug fixes. If you are not yet familiar on how to create a pull request, [read this great guide](https://gun.io/blog/how-to-github-fork-branch-and-pull-request).
|
| 20 |
|
| 21 | Some things that make it easier for us to accept your pull requests
|
| 22 |
|
| 23 | * The code adheres to our conventions
|
| 24 | * spaces instead of tabs
|
| 25 | * single-quotes
|
| 26 | * ...
|
| 27 | * The code is tested
|
| 28 | * The `grunt` build passes (executes tests + linting)
|
| 29 | * The work is combined into a single commit
|
| 30 | * The commit messages adhere to our [guideline](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y)
|
| 31 |
|
| 32 |
|
| 33 | We'd be glad to assist you if you do not get these things right in the first place.
|
| 34 |
|
| 35 | ## Maintaining the project
|
| 36 |
|
| 37 | Some notes for us maintainers only.
|
| 38 |
|
| 39 | ### Merge pull-requests
|
| 40 |
|
| 41 | When merging, try to do it manually (rebase on current master). This avoids merge messages.
|
| 42 |
|
| 43 | ### Release the project
|
| 44 |
|
| 45 | To release execute `grunt release(:major|:minor|:patch)`. Respect [semantic versioning](http://semver.org/) and choose correct next version based on latest changes.
|