| 1 | # Contributing To confit
|
| 2 |
|
| 3 | We are always looking for ways to make our modules better. Adding features and fixing bugs allows everyone who depends
|
| 4 | on this code to create better, more stable applications.
|
| 5 | Feel free to raise a pull request to us. Our team would review your proposed modifications and, if appropriate, merge
|
| 6 | your changes into our code. Ideas and other comments are also welcome.
|
| 7 |
|
| 8 | ## Getting Started
|
| 9 | 1. Create your own [fork](https://help.github.com/articles/fork-a-repo) of this [repository](../../fork).
|
| 10 | ```bash
|
| 11 | # Clone it
|
| 12 | $ git clone git@github.com:me/confit.git
|
| 13 |
|
| 14 | # Change directory
|
| 15 | $ cd confit
|
| 16 |
|
| 17 | # Add the upstream repo
|
| 18 | $ git remote add upstream git://github.com/krakenjs/confit.git
|
| 19 |
|
| 20 | # Get the latest upstream changes
|
| 21 | $ git pull upstream
|
| 22 |
|
| 23 | # Install dependencies
|
| 24 | $ npm install
|
| 25 |
|
| 26 | # Run scripts to verify installation
|
| 27 | $ npm test
|
| 28 | $ npm run lint
|
| 29 | $ npm run cover
|
| 30 | ```
|
| 31 |
|
| 32 | ## Making Changes
|
| 33 | 1. Make sure that your changes adhere to the current coding conventions used throughout the project, indentation, accurate comments, etc.
|
| 34 | 2. Lint your code regularly and ensure it passes prior to submitting a PR:
|
| 35 | `$ npm run lint`.
|
| 36 | 3. Ensure existing tests pass (`$ npm test`) and include test cases which fail without your change and succeed with it.
|
| 37 |
|
| 38 | ## Submitting Changes
|
| 39 | 1. Ensure that no errors are generated by JSLint, CSSLint or any other tools that you use for debugging your code.
|
| 40 | 2. Commit your changes in logical chunks, i.e. keep your changes small per single commit.
|
| 41 | 3. Locally merge (or rebase) the upstream branch into your topic branch: `$ git pull upstream && git merge`.
|
| 42 | 4. Push your topic branch up to your fork: `$ git push origin <topic-branch-name>`.
|
| 43 | 5. Open a [Pull Request](https://help.github.com/articles/using-pull-requests) with a clear title and description.
|
| 44 |
|
| 45 | If you have any questions about contributing, please feel free to contact us by posting your questions on GitHub.
|
| 46 |
|
| 47 | Copyright 2016 PayPal under [the Apache 2.0 license](LICENSE.txt).
|