Skip to content
This repository was archived by the owner on Jul 16, 2024. It is now read-only.

Commit 5a4f726

Browse files
lmouhibvgkowski
andauthored
fix: Update the CONTRIB_FAQ (#355)
* Update the CONTRIB_FAQ Adding a step to install `glob` to allow local build * Update pull-request-lint.yml (#356) update the pull-request-lint action to accept to accept PR with `doc` in title Co-authored-by: Vincent Gromakowski <[email protected]>
1 parent 007d9a8 commit 5a4f726

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

.github/workflows/pull-request-lint.yml

+1
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,5 @@ jobs:
2525
feat
2626
fix
2727
chore
28+
doc
2829
requireScope: false

CONTRIB_FAQ.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,15 @@
55
### How to setup Projen for Core components?
66

77
1. Go into `core` folder
8-
2. Install projen locally. Sometimes `projen` is installed globally and building throwns an error, deleting global `node_modules` folder solves the issue
8+
2. Install `glob` locally, this is used to find files based on patterns. It is used by a projen task to locate files like `.py` and `.java` to package them part of `lib`
9+
`npm install glob`
10+
3. Install projen locally. Sometimes `projen` is installed globally and building throwns an error, deleting global `node_modules` folder solves the issue
911

1012
`npm install projen`
11-
3. Build the core artificats
13+
4. Build the core artificats
1214

1315
`npx projen build`
14-
4. Only run unit test
16+
5. Only run unit test
1517

1618
`npx projen test`
1719

0 commit comments

Comments
 (0)