Skip to content

Commit 69cae7c

Browse files
committed
Update docs to reflect this change
1 parent d8ece3b commit 69cae7c

3 files changed

Lines changed: 14 additions & 2 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,5 @@ Before opening a pull request, developer should:
1818
7. select the _Allow edits from maintainers_ option (see this [article](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) for more details).
1919

2020
After opening a pull request, developer:
21-
- should create a new small markdown log file using the PR number e.g. `1010_fix.md` or `1010_add.md` inside `draftlogs` folder as described in this [README](https://github.com/plotly/plotly.js/blob/master/draftlogs/README.md), commit it and push.
21+
- should create a new small markdown log file using the PR number e.g. `1010_fix.md` or `1010_add.md` inside `draftlogs` folder as described in this [README](https://github.com/plotly/plotly.js/blob/master/draftlogs/README.md), commit it and push. A CI check enforces this; PRs that don't warrant a CHANGELOG entry can opt out by applying the `no-draftlog` label.
2222
- should **not** force push (i.e. `git push -f`) to remote branches associated with opened pull requests. Force pushes make it hard for maintainers to keep track of updates. Therefore, if required, please fetch `upstream/master` and "merge" with master instead of "rebase".

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ We use the following [labels](https://github.com/plotly/plotly.js/labels) to tra
7171
| `status: in progress` | PRs that required some initial feedback but not ready to merge |
7272
| `status: reviewable` | PRs that are completed from the author's perspective |
7373
| `status: on hold` | PRs that are put on hold |
74+
| `no-draftlog` | PR opted out of the [draftlog](./draftlogs/README.md) check |
7475

7576
## Development
7677

draftlogs/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,15 @@ If your PR falls into more than one category - for example adding a new feature
1919
which would render
2020
- Add `icicle` trace type [[#5546](https://github.com/plotly/plotly.js/pull/5546)]
2121

22-
> Please start your single-line or multiple lined message with a verb. You could basically use the PR description while providing a link to the PR similar to the above example is appreciated too.
22+
> Please start your single-line or multiple lined message with a verb.
23+
24+
Each entry must include a link back to the PR in the form shown above:
25+
`[[#1234](https://github.com/plotly/plotly.js/pull/1234)]` (a link to
26+
`/issues/1234` is also accepted, since GitHub redirects between the two).
27+
28+
### Skipping the draftlog
29+
30+
A CI check enforces that every pull request adds a new file under
31+
`draftlogs/`. If your PR genuinely does not warrant a CHANGELOG entry
32+
(e.g. a CI-only change, internal refactor, or docs typo), add the
33+
`no-draftlog` label to the PR to opt out.

0 commit comments

Comments
 (0)