mirror of
https://github.com/LukeHagar/redocly-cli.git
synced 2025-12-06 04:21:09 +00:00
chore: update contributing guide (#1606)
This commit is contained in:
@@ -32,6 +32,7 @@ Before submitting a pull request, please make sure the following is done:
|
||||
1. Ensure the test suite passes (see the [Tests section](#tests) for more details).
|
||||
1. Format your code with prettier (`npm run prettier`).
|
||||
1. Each feat/fix PR should also contain a changeset (to create one, run `npx changeset`; if your changes are scoped to `packages/core` but also affect Redocly CLI behavior, please include the `@redocly/cli` package as well). Please describe what you've done in this PR using sentence case (you can refer to our [changelog](https://redocly.com/docs/cli/changelog/)). This produces a file in `.changeset` folder. Please commit this file along with your changes. If the PR doesn't need a changeset (for example, it is a small change, or updates only documentation), add the 'No Changeset Needed' label to the PR.
|
||||
1. When merging a PR, make sure to remove all redundant commit information (like intermediate commit descriptions). Please leave only the main commit description (plus co-authors if needed). If you think it makes sense to keep several commit descriptions, please rebase your PR instead of squashing it to preserve the commits. Please use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format.
|
||||
|
||||
## Development setup
|
||||
|
||||
|
||||
@@ -23,6 +23,7 @@
|
||||
"cli-1.14": "npm:@redocly/cli@1.14.0",
|
||||
"cli-1.15": "npm:@redocly/cli@1.15.0",
|
||||
"cli-1.16": "npm:@redocly/cli@1.16.0",
|
||||
"cli-1.17": "npm:@redocly/cli@1.17.1",
|
||||
"cli-next": "file:../redocly-cli.tgz"
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user