Skip to content

Commit eefab9b

Browse files
committed
update and improve pull request template
1 parent 3a91c0e commit eefab9b

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,14 @@ Thanks for your interest in plotly.js!
99
### Features, Bug fixes, and others:
1010

1111
Before opening a pull request, developer should:
12+
1. make sure they are not on the `master` branch of their fork as using `master` for a pull request would make it difficult to fetch `upstream` changes.
13+
2. fetch latest changes from `upstream/master` into your fork i.e. `origin/master` then pull `origin/master` from you local `master`.
14+
3. then `git rebase master` their local dev branch off the latest `master` which should be sync with `upstream/master` at this time.
15+
4. make sure to **not** `git add` the `dist/` folder (the `dist/` is updated only on version bumps).
16+
5. make sure to commit changes to the `package-lock.json` file (if any new dependency required).
17+
6. provide a title and write an overview of what the PR attempts to do with a link to the issue they are trying to address.
18+
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).
1219

13-
- `git rebase` their local branch off the latest `master`,
14-
- make sure to **not** `git add` the `dist/` folder (the `dist/` is updated only on version bumps),
15-
- make sure to commit changes to the `package-lock.json` file (if any new dependency required),
16-
- write an overview of what the PR attempts to do,
17-
- 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).
18-
19-
Note that it is forbidden to 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 `git merge master` into your PR branch instead of `git rebase master`.
20+
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.
22+
- 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".

0 commit comments

Comments
 (0)