diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3e709b36f..aea2f10e2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,26 +12,26 @@ We welcome contributions from anyone on the internet and are grateful for even t Before removing the `[WIP]` tag and submitting the PR for review, make sure: -* It passes our linter checks (`yarn lint`) -* It is properly formatted with Prettier (`yarn prettier`) -* It passes our continuous integration tests (See: [Enabling code coverage checks on your fork](#enabling-code-coverage-checks-on-your-fork) for instructions on getting the `submit-coverage` test to pass on forks) -* You've created/updated the corresponding [CHANGELOG](#CHANGELOGs) entries. -* Your changes have sufficient test coverage (e.g regression tests have been added for bug fixes) +- It passes our linter checks (`yarn lint`) +- It is properly formatted with Prettier (`yarn prettier`) +- It passes our continuous integration tests (See: [Enabling code coverage checks on your fork](#enabling-code-coverage-checks-on-your-fork) for instructions on getting the `submit-coverage` test to pass on forks) +- You've created/updated the corresponding [CHANGELOG](#CHANGELOGs) entries. +- Your changes have sufficient test coverage (e.g regression tests have been added for bug fixes) ### Branch structure We have two main branches: -* `master` represents the most recently released (published on npm) version of the codebase. -* `development` represents the current development state of the codebase. +- `master` represents the most recently released (published on npm) version of the codebase. +- `development` represents the current development state of the codebase. ALL PRs should be opened against `development`. Branch names should be prefixed with `fix`, `feature` or `refactor`. -* e.g `fix/broken-wiki-link` -* If the PR only edits a single package, add it's name too - * e.g `fix/website/broken-wiki-link` +- e.g `fix/broken-wiki-link` +- If the PR only edits a single package, add it's name too + - e.g `fix/website/broken-wiki-link` ### CHANGELOGs @@ -67,8 +67,8 @@ If you want to change a rule, or add a custom rule, please make these changes to Integrate it into your text editor: -* VSCode: [vscode-tslint](https://marketplace.visualstudio.com/items?itemName=eg2.tslint) -* Atom: [linter-tslint](https://atom.io/packages/linter-tslint) +- VSCode: [vscode-tslint](https://marketplace.visualstudio.com/items?itemName=eg2.tslint) +- Atom: [linter-tslint](https://atom.io/packages/linter-tslint) #### Auto-formatter @@ -76,8 +76,8 @@ We use [Prettier](https://prettier.io/) to auto-format our code. Be sure to eith If using the Atom text editor, we recommend you install the following packages: -* VSCode: [prettier-vscode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) -* Atom: [prettier-atom](https://atom.io/packages/prettier-atom) +- VSCode: [prettier-vscode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) +- Atom: [prettier-atom](https://atom.io/packages/prettier-atom) ## Unenforced coding conventions |