Skip to content

Commit e7bb56f

Browse files
authored
Pull request template (piotrwitek#191)
* Added issue templates * Added pull request template and updated contributing guide
1 parent 4e3bc87 commit e7bb56f

File tree

2 files changed

+20
-11
lines changed

2 files changed

+20
-11
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<!-- Thank you for your contribution! :thumbsup: -->
2+
<!-- Please makes sure that these checkboxes are checked before submitting your PR, thank you! -->
3+
4+
## Description
5+
<!-- Example: Added error property support to `action` API -->
6+
7+
## Related issues:
8+
- Resolved #XXX
9+
10+
## Checklist
11+
12+
* [ ] I have edited `README_SOURCE.md` (NOT `README.md`)
13+
* [ ] I have run `sh ./generate-readme.sh` script to generate an updated `README.md` (alternatively you can run `node ./generate-readme.js`)
14+
15+
* [ ] I have read [CONTRIBUTING.md](../CONTRIBUTING.md)
16+
* [ ] I have linked all related issues above
17+
* [ ] I have rebased my branch
18+

CONTRIBUTING.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,8 @@
55
2. Before submitting a PR please comment in the relevant issue (or create a new one if it doesn't exist yet) to discuss all the requirements (this will prevent rejecting the PR and wasting your work).
66
3. All workflow scripts (prettier, linter, tests) must pass successfully (it is run automatically on CI and will fail on github checks).
77

8-
## PR Checklist
9-
- generate a new `README.md` from `README_SOURCE.md` using command:
10-
```
11-
sh ./generate-readme.sh
12-
13-
# or if you don't like bash, simply use node.js
14-
# node ./generate-readme.js
15-
```
16-
17-
## `README.md` and `README_SOURCE.md`
18-
Don't edit `README.md` directly - it is generated automatically from `README_SOURCE.md` using script.
8+
## Edit `README_SOURCE.md` to generate an updated `README.md`
9+
Don't edit `README.md` directly - it is generated automatically from `README_SOURCE.md` using an automated script.
1910
- Use `sh ./generate-readme.sh` script to generate updated `README.md` (this will inject code examples using type-checked source files from the `/playground` folder)
2011
- So to make changes in code examples edit source files in `/playground` folder
2112

0 commit comments

Comments
 (0)