Skip to content

Commit 6ecbca8

Browse files
MatteoPologrutoper1234
authored andcommitted
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 8855f61 commit 6ecbca8

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

README.md

+35-2
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,41 @@ The action accepts some properties:
7373
case-insensitive-regex: true
7474
```
7575
76-
## Development
76+
## Development workflow
77+
78+
### 1. Install tools
79+
80+
#### Node.js
81+
82+
[**npm**](https://www.npmjs.com/) is used for dependency management.
83+
84+
Follow the installation instructions here:<br />
85+
https://nodejs.dev/download
86+
87+
### 2. Install dependencies
7788
7889
To work on the codebase you have to install all the dependencies:
7990
8091
```
8192
npm install
8293
```
8394
95+
### 3. Coding
96+
97+
Now you're ready to work some [TypeScript](https://www.typescriptlang.org/) magic!
98+
99+
Make sure to write or update tests for your work when appropriate.
100+
101+
### 4. Format code
102+
103+
Format the code to follow the standard style for the project:
104+
105+
```
106+
npm run format
107+
```
108+
109+
### 5. Run tests
110+
84111
To run tests:
85112
86113
```
@@ -89,7 +116,13 @@ npm run test
89116
90117
See the [official Github documentation][pat-docs] to know more about Personal Access Tokens.
91118
92-
## Release
119+
### 6. Commit
120+
121+
Everything is now ready to make your contribution to the project, so commit it to the repository and submit a pull request.
122+
123+
Thanks!
124+
125+
## Release workflow
93126
94127
1. `npm install` to add all the dependencies, included development.
95128
2. `npm run build` to build the Action under the `./lib` folder.

0 commit comments

Comments
 (0)