|
| 1 | +# Contributing to react-a11y |
| 2 | + |
| 3 | +## Setting up the workspace |
| 4 | + |
| 5 | +Before you can submit a Pull Request you'll need to do the following: |
| 6 | + |
| 7 | +1. Fork the repository on GitHub |
| 8 | + |
| 9 | +2. Clone your fork |
| 10 | + |
| 11 | +```bash |
| 12 | +git clone https://github.com/<your_username>/react-a11y.git |
| 13 | +cd react-a11y |
| 14 | +``` |
| 15 | + |
| 16 | +3. Install for development |
| 17 | + |
| 18 | +```bash |
| 19 | +npm install |
| 20 | +``` |
| 21 | + |
| 22 | +## Workflow |
| 23 | + |
| 24 | +Lint the code: |
| 25 | + |
| 26 | +```bash |
| 27 | +npm run lint |
| 28 | +``` |
| 29 | + |
| 30 | +Run the tests: |
| 31 | + |
| 32 | +```bash |
| 33 | +npm run mocha // run tests using mocha only |
| 34 | +npm run karma // run tests using karma only |
| 35 | +npm run test // run tests using both mocha and karma |
| 36 | +``` |
| 37 | + |
| 38 | +Build the code: |
| 39 | + |
| 40 | +```bash |
| 41 | +npm run build |
| 42 | +``` |
| 43 | + |
| 44 | +## Making changes |
| 45 | + |
| 46 | +1. Checkout a new branch and name it accordingly to what you intend to do |
| 47 | + |
| 48 | +```bash |
| 49 | +git checkout -b <branch_name> |
| 50 | +``` |
| 51 | + |
| 52 | +2. Make your intended changes, being sure to run the tests and lint the code. |
| 53 | + |
| 54 | +## Submitting a Pull Request |
| 55 | + |
| 56 | +1. Commit your changes (please make commits small and commit messages descriptive): |
| 57 | + |
| 58 | +```bash |
| 59 | + git commit -m "..." |
| 60 | +``` |
| 61 | + |
| 62 | +2. Push to _your_ github repo: |
| 63 | +```bash |
| 64 | +git push origin <branch_name> |
| 65 | +``` |
| 66 | + |
| 67 | +3. Go to the GitHub page and click "New Pull request". |
| 68 | +4. Write a good description of the change. |
| 69 | + |
| 70 | +After sending a pull request, other developers will review and discuss your change. Please address all the comments. Once everything is all right, one of the maintainers will merge your changes in. |
| 71 | + |
| 72 | +## Publishing (for maintainers) |
| 73 | +_These steps are for maintainers only and can be disregarded by contributors._ |
| 74 | + |
| 75 | +For publishing use the following workflow: |
| 76 | + |
| 77 | +1. Make sure all code changes for this new version have already been committed. |
| 78 | + |
| 79 | +2. Update the CHANGELOG.md with the changes for this version and save (don't commit). |
| 80 | + |
| 81 | +3. Update the version and publish. This is done by running _one_ of the following scripts: |
| 82 | + |
| 83 | +```bash |
| 84 | +npm version:patch # for a patch version update i.e. v1.0.0 -> v1.0.1 |
| 85 | +npm version:minor # for a minor version update i.e. v1.0.0 -> v1.1.0 |
| 86 | +npm version:major # for a major version update i.e. v.1.0.0 -> v2.0.0 |
| 87 | +``` |
| 88 | + |
| 89 | +### The publishing scripts |
| 90 | +After running one of the above `version:*` scripts the following things will take place in this order: |
| 91 | + |
| 92 | +1. the `preversion` script will run which does the following: |
| 93 | + |
| 94 | + 1. The tests will be run and the entire process will halt if they do not all pass |
| 95 | + |
| 96 | + 2. A check will be performed to validate that the `CHANGELOG.md` has been updated and it is the only uncommitted change in the repo. If this check fails the process will be halted. |
| 97 | + |
| 98 | +2. the selected `version:*` script will run which does the following: |
| 99 | + |
| 100 | + 1. The version in `package.json` will be incremented as requested (patch, minor, major). _Because the `--no-git-tag-version` flag is specified this script will not yet include tagging and committing in the github repo._ |
| 101 | + |
| 102 | +3. the `postversion` script will be run which does the following: |
| 103 | + |
| 104 | + 1. A `git commit` will be made including only the `package.json` and `CHANGELOG.md` files. It will include a commit comment in the format of: "Version $npm_package_version" |
| 105 | + |
| 106 | + 2. Performs a `git tag` in the format of "v$npm_package_version" |
| 107 | + |
| 108 | + 3. Performs a `git push` and `git push --tags` |
| 109 | + |
| 110 | + 4. Runs `npm publish` |
| 111 | + |
| 112 | + |
| 113 | +## Additional Resources |
| 114 | +* [GitHub pull request help](https://help.github.com/categories/collaborating-with-issues-and-pull-requests/) |
0 commit comments