File tree Expand file tree Collapse file tree 2 files changed +29
-24
lines changed
Expand file tree Collapse file tree 2 files changed +29
-24
lines changed Original file line number Diff line number Diff line change 1+ ## Development
2+
3+ To work on the codebase you have to install all the dependencies:
4+
5+ ``` sh
6+ # npm install
7+ ```
8+
9+ To run tests set the environment variable ` GITHUB_TOKEN ` with a valid Personal Access Token and then:
10+
11+ ``` sh
12+ # npm run test
13+ ```
14+
15+ See the [ official Github documentation] [ pat-docs ] to learn more about Personal Access Tokens.
16+
17+ ## Release
18+
19+ 1 . ` npm install ` to add all the dependencies, included development.
20+ 2 . ` npm run build ` to build the Action under the ` ./lib ` folder.
21+ 3 . ` npm run test ` to see everything works as expected.
22+ 4 . ` npm run pack ` to package for distribution
23+ 5 . ` git add src dist ` to check in the code that matters.
24+ 6 . open a PR and request a review.
25+
26+ [ pat-docs ] : https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token
Original file line number Diff line number Diff line change @@ -117,29 +117,8 @@ jobs:
117117 - uses : arduino/arduino-lint-action@v1
118118` ` `
119119
120- ## Development
120+ ## Contributing
121121
122- To work on the codebase you have to install all the dependencies:
122+ To report bugs or make feature requests, please submit an issue: https://github.com/arduino/arduino-lint-action/issues
123123
124- ` ` ` sh
125- # npm install
126- ```
127-
128- To run tests set the environment variable ` GITHUB_TOKEN ` with a valid Personal Access Token and then:
129-
130- ``` sh
131- # npm run test
132- ```
133-
134- See the [ official Github documentation] [ pat-docs ] to know more about Personal Access Tokens.
135-
136- ## Release
137-
138- 1 . ` npm install ` to add all the dependencies, included development.
139- 2 . ` npm run build ` to build the Action under the ` ./lib ` folder.
140- 3 . ` npm run test ` to see everything works as expected.
141- 4 . ` npm run pack ` to package for distribution
142- 5 . ` git add src dist ` to check in the code that matters.
143- 6 . open a PR and request a review.
144-
145- [ pat-docs ] : https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
124+ Pull requests are welcome! Please see the [contribution guidelines](.github/CONTRIBUTING.md) for information.
You can’t perform that action at this time.
0 commit comments