Permalink
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
codeql-action/node_modules/prettier-linter-helpers/.github/CONTRIBUTING.md
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
41 lines (28 sloc)
995 Bytes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Contributing | |
Thanks for contributing! | |
## Installation | |
```sh | |
git clone https://github.com/prettier/prettier-linter-helpers.git | |
cd prettier-linter-helpers | |
yarn install | |
``` | |
## Running the tests | |
```sh | |
yarn run test | |
``` | |
Linting is ran as part of `yarn run test`. The build will fail if there are any linting errors. You can run `yarn run lint --fix` to fix some linting errors (including formatting to match prettier's expectations). To run the tests without linting run `yarn run test`. | |
## Publishing | |
- Ensure you are on the master branch locally. | |
- Update `CHANGELOG.md` and commit. | |
- Run the following: | |
```sh | |
yarn publish | |
git push --follow-tags | |
``` | |
Running `yarn publish` shall: | |
- Bump the version in package.json (asking you for the new version number) | |
- Create a new commit containing that version bump in package.json | |
- Create a tag for that commit | |
- Publish to the npm repository | |
Running `git push --follow-tags` shall: | |
- Push the commit and tag to GitHub |