You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
snabbdom/CONTRIBUTING.md

48 lines
1.0 KiB
Markdown

# Contributing
## Allowing CI builds of pull requests from forks
Some secrets are included as environment variables in the CI build.
Since code in forks is considered un-trusted,
CI builds of pull requests from forks are run without secrets.
This causes the CI build to fail.
To mark the HEAD of a pull request as trusted
— which would trigger a build that includes the secrets —
run the following command:
```sh
npm run mark-pr-head-as-trusted -- <pr number>
```
## Making a release
Make sure you have permission to publish, by running
npm access ls-collaborators
While on the `master` branch, switch to a new branch, possibly called `release`:
git switch --create release
npm run make-release-commit
Create a new pull request from this branch. The name of the pull request possibly identical to the commit message.
"Rebase and merge" the pull request.
git switch master
git pull
Where `$VERSION` is the new version, run
git tag v$VERSION
For example:
git tag v5.2.4
And then
git push --tags
npm publish