Skip to content

Commit 0c693f8

Browse files
committed
Add CONTRIBUTING
1 parent 260ca90 commit 0c693f8

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Development guide
2+
3+
## Trying it out locally
4+
5+
### Example
6+
7+
```bash
8+
tmp=$(mktemp -d) && touch "$tmp"/{path,env}
9+
export RUNNER_TEMP="$tmp" GITHUB_PATH="$tmp/path" GITHUB_ENV="$tmp/env"
10+
env PATH="$(pwd)/.tools:$PATH" INPUT_CRYSTAL=nightly INPUT_SHARDS=true INPUT_TOKEN="$personal_access_token" INSTALL_CRYSTAL_PLATFORM=win32 node index.js
11+
```
12+
13+
## Pre-commit
14+
15+
Make sure that `npm test` passes. A pre-commit hook is available: `git config core.hooksPath .tools/hooks`.
16+
17+
## CI
18+
19+
Continuous testing runs on GitHub Actions. Make sure that _.github/workflows/main.yml_ and _release.yml_ stay in sync, other than the differences that they already have.
20+
21+
## Cutting a release
22+
23+
Switch to _master_ branch, in a clean state. Run `.tools/release.sh x.y.z` (an actual next version number). You will be switched to the _v1_ branch, _node_modules_ will be populated, and a tag will be created. The final command to push all this will be only printed. Run it. After this, a release also needs to be published on GitHub Marketplace.
24+
25+
### _node_modules_
26+
27+
The _node_modules_ directory must not be present in the _master_ branch. _package-lock.json_ will be present, though.

0 commit comments

Comments
 (0)