Create PR Template and update RELEASE based on feedback
This commit is contained in:
parent
794d94494b
commit
3670bfaac3
25
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
25
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
## Description
|
||||||
|
|
||||||
|
<!-- describe what the PR does -->
|
||||||
|
|
||||||
|
- Fixes ####
|
||||||
|
- Fixes list issues fixed by this PR
|
||||||
|
- Fixes will automatically close them once merged
|
||||||
|
|
||||||
|
## Review
|
||||||
|
|
||||||
|
### Submitter
|
||||||
|
|
||||||
|
- [ ] All tests pass (CI should take care of this, once in place).
|
||||||
|
- [ ] All lint checks pass (CI should take care of this, once in place).
|
||||||
|
- Tests
|
||||||
|
- [ ] Test(s) exist to ensure functionaly works (if no new tests added, list which tests cover this funcitonality).
|
||||||
|
- [ ] No tests required for this PR.
|
||||||
|
- If release:
|
||||||
|
- [ ] Version in `package.json` has been updated (see [RELEASE.md](RELEASE.md)).
|
||||||
|
- [ ] The `marked.min.js` has been updated; or,
|
||||||
|
- [ ] release does not change library.
|
||||||
|
|
||||||
|
### Reviewer
|
||||||
|
|
||||||
|
??
|
@ -18,6 +18,8 @@ We follow [semantic versioning](https://semver.org) where the following sequence
|
|||||||
- `$ npm version [major|minor|patch]` (updates `package.json` and creates `min` file)
|
- `$ npm version [major|minor|patch]` (updates `package.json` and creates `min` file)
|
||||||
- `$ npm publish` (publish to NPM)
|
- `$ npm publish` (publish to NPM)
|
||||||
- [ ] Commit changes locally -> Submit PR to `origin/master` -> Merge PR
|
- [ ] Commit changes locally -> Submit PR to `origin/master` -> Merge PR
|
||||||
|
- `package.json` should, at minimum, have an updated version number.
|
||||||
|
- If the release contains changes to the library (most likely) you should also see a new `marked.min.js` file.
|
||||||
- [ ] Navigate to the "Releases" tab on the project main page -> "Draft new release"
|
- [ ] Navigate to the "Releases" tab on the project main page -> "Draft new release"
|
||||||
- Add version number matching the one in the `package.json` file after publishing the release
|
- Add version number matching the one in the `package.json` file after publishing the release
|
||||||
- Make sure `master` is the branch from which the release will be made
|
- Make sure `master` is the branch from which the release will be made
|
||||||
|
Loading…
x
Reference in New Issue
Block a user