Skip to content

Commit df25179

Browse files
committed
Update README with development instructions
Signed-off-by: Matthew Peveler <[email protected]>
1 parent 8e85585 commit df25179

File tree

2 files changed

+27
-2
lines changed

2 files changed

+27
-2
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,28 @@ jobs:
2323
steps:
2424
- uses: submitty/action-pr-title@master
2525
```
26+
27+
## Development
28+
29+
### Requirements:
30+
31+
* NodeJS 12+
32+
33+
### Setup
34+
35+
```bash
36+
npm install
37+
```
38+
39+
### Contributing
40+
41+
For new code, you will need to:
42+
43+
1. Write the code
44+
1. Lint the code (`npm run lint`) and test it (`npm run test`)
45+
46+
After you're satisfied with the changes you've made, you will want to finally update the files under `dist/` with your change
47+
by running `npm run package`. Make sure to commit these changed files, as these are the files that are used when people utilize
48+
this action!
49+
50+
With that done, create a PR!

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{
22
"name": "action-pr-title",
33
"version": "1.0.0",
4-
"description": "",
4+
"description": "GitHub action to validate PR titles meet our guidelines",
55
"main": "lib/index.js",
66
"scripts": {
77
"build": "tsc",
88
"lint": "eslint src test",
99
"lint:fix": "prettier --write \"**/*.ts\"",
10-
"package": "ncc build --source-map --license licenses.txt",
10+
"package": "npm run build && ncc build --source-map --license licenses.txt",
1111
"test": "TS_NODE_PROJECT='./tsconfig.test.json' mocha --require ts-node/register --reporter spec --recursive './test/**/*.ts'",
1212
"prepare": "husky install"
1313
},

0 commit comments

Comments
 (0)