| 1 | # Contributing
|
| 2 |
|
| 3 | We'd like to encourage you to contribute to the repository. You can do this by making an [issue ticket](https://github.com/node-influx/node-influx/issues) or, even better, submitting a patch via a pull request.
|
| 4 |
|
| 5 | We try to make it as easy as possible for you but there are a few things to consider when contributing. The following guidelines for contribution should be followed if you want to submit a pull request:
|
| 6 |
|
| 7 | ## How to prepare
|
| 8 |
|
| 9 | - You need a [GitHub account](https://github.com/signup/free)
|
| 10 | - Submit an [issue ticket](https://github.com/node-influx/node-influx/issues) for your issue if there is not one yet.
|
| 11 | _ Describe the issue and include steps to reproduce if it's a bug.
|
| 12 | _ Ensure to mention the earliest version that you know is affected.
|
| 13 | - If you are able and want to fix this, fork the repository on GitHub
|
| 14 |
|
| 15 | ## Make Changes
|
| 16 |
|
| 17 | - In your forked repository, create a topic branch for your upcoming patch. (e.g. `feature--autoplay` or `bugfix--ios-crash`)
|
| 18 | _ Usually this is based on the master branch.
|
| 19 | _ Create a branch based on master; `git branch fix/master/my_contribution master` then checkout the new branch with `git checkout fix/master/my_contribution`. Please avoid working directly on the `master` branch.
|
| 20 | - Make sure you follow the established coding style. You can run `npm run test:lint` to verify you're all set.
|
| 21 | - Make use of the `.editorconfig`-file if provided with the repository.
|
| 22 | - Make commits of logical units and describe them properly, documenting anything new that you add.
|
| 23 | - If possible, submit tests to your patch / new feature so it can be tested easily.
|
| 24 | - Assure nothing is broken by running all the tests via `npm test`.
|
| 25 |
|
| 26 | ## Submit Changes
|
| 27 |
|
| 28 | - Push your changes to a topic branch in your fork of the repository.
|
| 29 | - Open a pull request to the this repository and choose the right original branch you want to patch.
|
| 30 | - If not done in commit messages (which you really should do) please reference and update your issue with the code changes. But _please do not close the issue yourself_.
|
| 31 | - We'll review your changes and respond soon, usually within a day!
|
| 32 |
|
| 33 | ## Additional Resources
|
| 34 |
|
| 35 | - [General GitHub documentation](http://help.github.com/)
|
| 36 | - [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
|