Skip to content

Commit 7e1d12d

Browse files
committed
Use ordered list for development section of contributor guide
The development process for contributors follows a reasonably linear set of distinct steps, so this is an appropriate way of organizing the information.
1 parent 8bfc956 commit 7e1d12d

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

.github/CONTRIBUTING.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,38 @@
1-
## Development
1+
## Development workflow
2+
3+
### 1. Install tools
4+
5+
#### Node.js
6+
7+
[**npm**](https://www.npmjs.com/) is used for dependency management.
8+
9+
Follow the installation instructions here:<br />
10+
https://nodejs.dev/download
11+
12+
### 2. Install dependencies
213

314
To work on the codebase you have to install all the dependencies:
415

516
```
617
npm install
718
```
819

20+
### 3. Coding
21+
22+
Now you're ready to work some [TypeScript](https://www.typescriptlang.org/) magic!
23+
24+
Make sure to write or update tests for your work when appropriate.
25+
26+
### 4. Format code
27+
28+
Format the code to follow the standard style for the project:
29+
30+
```
31+
npm run format
32+
```
33+
34+
### 5. Run tests
35+
936
To run tests set the environment variable `GITHUB_TOKEN` with a valid Personal Access Token and then:
1037

1138
```
@@ -14,7 +41,13 @@ npm run test
1441

1542
See the [official Github documentation][pat-docs] to learn more about Personal Access Tokens.
1643

17-
## Release
44+
### 6. Commit
45+
46+
Everything is now ready to make your contribution to the project, so commit it to the repository and submit a pull request.
47+
48+
Thanks!
49+
50+
## Release workflow
1851

1952
1. `npm install` to add all the dependencies, included development.
2053
1. `npm run build` to build the Action under the `./lib` folder.

0 commit comments

Comments
 (0)