|
1 | 1 | # Contributing
|
2 | 2 |
|
3 |
| -First, thank you for your interest in contributing to this project, teamwork makes the dreamwork! When contributing |
| 3 | +First, thank you for your interest in contributing to this project, teamwork makes the dream work! When contributing |
4 | 4 | to this repository, please first discuss the change you wish to make via issue, with the owners of this repository
|
5 |
| -before making a change. This will greatly speed up the process of determing if and how your contrbution will fit |
| 5 | +before making a change. This will greatly speed up the process of determining if and how your contribution will fit |
6 | 6 | into the project.
|
7 | 7 |
|
8 | 8 | ## Pull Request Process
|
9 | 9 |
|
10 |
| -1. Ensure any install or build dependencies are removed before the end of the layer when doing a |
| 10 | +1. Ensure any install or build dependencies are removed before the end of the layer when doing a |
11 | 11 | build.
|
12 | 12 | 2. Include useful information about the changes you are wanting to contribute, including: what you've done, the
|
13 | 13 | intended goal and any possible side effects or breaking changes relative to previous version.
|
14 | 14 | 3. If your pull request intends to fix a specific issue please reference that in the pull request message.
|
15 | 15 | 4. Do not increment the version number, this will be done by one of the maintainers as needed. The versioning scheme
|
16 | 16 | we use is [SemVer](http://semver.org/).
|
17 |
| -5. Pull requests will only be merged after the code is reviewed, requested changes made and the changes are sufficently |
| 17 | +5. Pull requests will only be merged after the code is reviewed, requested changes made and the changes are sufficiently |
18 | 18 | covered by the test suite.
|
19 | 19 |
|
20 | 20 | ## Coding Conventions
|
21 | 21 |
|
22 | 22 | Effort is taken to make ensure code is first and foremost readable, below are some quick guidelines to follow. When in
|
23 |
| -doubt if it doesn't match the existing style you will likely be asked to refomat accordingly (i.e. listen to the linter). |
| 23 | +doubt if it doesn't match the existing style you will likely be asked to reformat accordingly (i.e. listen to the linter). |
24 | 24 | * All JavaScript and free form Fortran code is indented two spaces
|
25 |
| - * Parser output in unit tests (corpus/*.txt) is indented two spaces |
| 25 | + * Parser output in unit tests (corpus/\*.txt) is indented two spaces |
26 | 26 | * Parser ouput in unit tests is logically grouped to reduce the vertical space required
|
27 | 27 | * Line length is preferred to be 80 characters or less
|
28 |
| - |
| 28 | + |
29 | 29 | ## Commit Messages
|
30 | 30 |
|
31 | 31 | Good clean commit messages benefit everyone, please refer to https://chris.beams.io/posts/git-commit. To summarize
|
|
0 commit comments