|
1 | | -# Contributing to Webpack Typings for JSON |
| 1 | +# DURING RELEASE |
2 | 2 |
|
3 | | -Thanks for your interest in contributing to this project. |
4 | | - |
5 | | -## Pull Request guidelines |
6 | | - |
7 | | -Before working on a Pull Request, create an issue explaining what you want to contribute. |
8 | | -This ensures that your pull request won't go unnoticed, and that you are not contributing |
9 | | -something that is not suitable for the project. |
10 | | - |
11 | | -If you are unfamiliar with GitHub Pull Requests, please read the following documentation: |
12 | | -https://help.github.com/articles/using-pull-requests |
13 | | - |
14 | | -**Your Pull Request must:** |
15 | | - |
16 | | -* Address a single issue or add a single item of functionality. |
17 | | -* Contain a clean history of small, incremental, logically separate commits, with no merge commits. |
18 | | -* Use clear commit messages. |
19 | | -* Be possible to merge automatically. |
20 | | - |
21 | | -## Submitting a Pull Request |
22 | | - |
23 | | -1. Make your changes in a new git branch: `git checkout -b my-fix-branch master` |
24 | | -2. Create your patch or feature |
25 | | -3. Ensure the builds work by running: `npm run build` |
26 | | -4. Ensure the tests will pass by running: `npm run test` |
27 | | -5. Ensure the code is formatted by running: `npm run eslint:fix` |
28 | | -6. Commit your changes using a descriptive commit message |
29 | | - |
30 | | -After your Pull Request is created, it will automatically be build using Circle CI. |
31 | | -When the build is successful then the Pull Request is ready for review. |
0 commit comments