|
| 1 | +# Contributing to react-paypal-js |
| 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 | + |
| 10 | +1. Create your own [fork](https://help.github.com/articles/fork-a-repo) of this [repository](../../fork). |
| 11 | + |
| 12 | +```bash |
| 13 | +# Clone it |
| 14 | +$ git clone [email protected]:me/react-paypal-js.git |
| 15 | + |
| 16 | +# Change directory |
| 17 | +$ cd react-paypal-js |
| 18 | + |
| 19 | +# Add the upstream repo |
| 20 | +$ git remote add upstream [email protected]:paypal/react-paypal-js.git |
| 21 | + |
| 22 | +# Get the latest upstream changes |
| 23 | +$ git pull upstream |
| 24 | + |
| 25 | +# Install dependencies |
| 26 | +$ npm install |
| 27 | + |
| 28 | +# Run scripts to verify installation |
| 29 | +$ npm run validate |
| 30 | +``` |
| 31 | + |
| 32 | +## Making Changes |
| 33 | + |
| 34 | +1. Make sure that your changes adhere to the current coding conventions used throughout the project, indentation, accurate comments, etc. |
| 35 | +2. Ensure existing tests pass (`$ npm test`) and include test cases which fail without your change and succeed with it. |
| 36 | + |
| 37 | +## Submitting Changes |
| 38 | + |
| 39 | +1. Ensure that no errors are generated by ESLint (run during `$ npm test`). |
| 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 | +6. You should follow the [Angular.js commit message guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) for both your commit messages and PR titles. |
| 45 | + |
| 46 | +If you have any questions about contributing, please feel free to contact us by posting your questions on GitHub. |
| 47 | + |
| 48 | +Copyright 2020-present, PayPal, Inc. under [the Apache 2.0 license](LICENSE.txt). |
0 commit comments