Skip to content

Commit f5c06ca

Browse files
committed
update main<->docs merge instructions in CONTRIBUTING.md
1 parent 73bf496 commit f5c06ca

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,12 @@ This site was used to generate the favicon from a high-res PNG export of the SVG
4444

4545
## Release checklist
4646

47-
1. Merge `docs` into `main`
47+
1. Merge `docs` into `main` using a pull request, ensuring a consistent squash-merge
4848
2. Rebuild the README (see instructions above, necessary because npmjs.com renders the readme)
4949
3. Publish with `np`
5050
4. Add changelog to the Github Release; match formatting from previous releases
51-
5. Merge `main` into `docs` (this automatically rebuilds the website)
51+
5. Move `docs` branch to head of `main`
52+
- this rebuilds the website
53+
- `git push --force origin main:docs`
54+
- avoids merge messiness due to earlier squash-merge from `docs` to `main`
5255
6. If tsconfig schema has changed, send a pull request to schemastore. [Example](https://github.com/SchemaStore/schemastore/pull/1208)

0 commit comments

Comments
 (0)