Skip to content

Commit 61961a8

Browse files
committed
Improve contributing guide
1 parent 6c939b8 commit 61961a8

File tree

1 file changed

+6
-21
lines changed

1 file changed

+6
-21
lines changed

CONTRIBUTING.md

+6-21
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ make build
2020

2121
After building the project, you can run the main binary that is produced.
2222

23-
2423
```bash
2524
make start
2625
```
@@ -29,7 +28,6 @@ make start
2928

3029
You can run the test compiled executable:
3130

32-
3331
```bash
3432
make test
3533
```
@@ -38,7 +36,6 @@ make test
3836

3937
Documentation for the libraries in the project can be generated with:
4038

41-
4239
```bash
4340
make doc
4441
open-cli $(make doc-path)
@@ -50,30 +47,18 @@ This assumes you have a command like [open-cli](https://github.com/sindresorhus/
5047
5148
### Releasing
5249

53-
To release prebuilt binaries to all platforms, we use Github Actions to build each binary individually.
50+
To release prebuilt binaries to all platforms, we use GitHub Actions to build each binary individually.
5451

55-
The binaries are then uploaded to a Github Release and NPM automatically.
52+
The binaries are then uploaded to a GitHub Release.
5653

5754
To trigger the Release workflow, you need to push a git tag to the repository.
58-
We provide a script that will bump the version of the project, tag the commit and push it to Github:
55+
We provide a script that will bump the version of the project, tag the commit and push it to GitHub:
5956

6057
```bash
61-
./script/release.sh
58+
make release
6259
```
6360

64-
The script will release the current project version on Opam, update the documentation and push a new tag on Github.
65-
66-
### Releasing
67-
68-
To create a release and publish it on Opam, first update the `CHANGES.md` file with the last changes and the version that you want to release.
69-
The, you can run the script `script/release.sh`. The script will perform the following actions:
70-
71-
- Create a tag with the version found in `spin.opam`, and push it to your repository.
72-
- Create the distribution archive.
73-
- Publish the distribution archive to a Github Release.
74-
- Submit a PR on Opam's repository.
75-
76-
When the release is published on Github, the CI/CD will trigger the `Release` workflow which will compile binaries for all supported platforms and add them to the Github Release as assets.
61+
The script will release the current project version on Opam, update the documentation and push a new tag on GitHub.
7762

7863
### Repository Structure
7964

@@ -82,7 +67,7 @@ The following snippet describes Spin's repository structure.
8267
```text
8368
.
8469
├── .github/
85-
| Contains Github specific files such as actions definitions and issue templates.
70+
| Contains GitHub specific files such as actions definitions and issue templates.
8671
8772
├── bin/
8873
| Source for Spin's binary. This links to the library defined in `lib/`.

0 commit comments

Comments
 (0)