Skip to content

Commit 6571586

Browse files
authored
Merge pull request #753 from plotly/issue-pr-template-fix
Minor cleanup for issue & PR templates
2 parents f8b35f8 + 2d95b41 commit 6571586

File tree

3 files changed

+9
-57
lines changed

3 files changed

+9
-57
lines changed

.github/ISSUE_TEMPLATE.md

+4-15
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,9 @@
11
Thanks for your interest in plotly.js!
22

3-
Before opening an issue, please search for existing and closed issues. If your
4-
problem or idea is not addressed yet,
5-
[please open a new issue](https://github.com/plotly/plotly.js/issues/new).
3+
Before opening an issue, please search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/plotly/plotly.js/issues/new).
64

7-
Bug reports must be accompanied with a reproducible example. We recommend using
8-
[codepen](http://codepen.io/), [jsfiddle](https://jsfiddle.net/) or
9-
[jsbin](https://jsbin.com) to share your example.
5+
Bug reports must be accompanied with a reproducible example. We recommend using [codepen](http://codepen.io/), [jsfiddle](https://jsfiddle.net/) or [jsbin](https://jsbin.com) to share your example.
106

11-
Note that GitHub issues are reserved for bug reports and feature requests only.
12-
Implementation questions should be asked on
13-
community.plot.ly (tagged [`plotly-js`](http://community.plot.ly/c/plotly-js)) or on Stack Overflow (tagged
14-
[`plotly`](https://stackoverflow.com/questions/tagged/plotly)).
7+
Note that GitHub issues are reserved for bug reports and feature requests only. Implementation questions should be asked on community.plot.ly (tagged [`plotly-js`](http://community.plot.ly/c/plotly-js)) or on Stack Overflow (tagged [`plotly`](https://stackoverflow.com/questions/tagged/plotly)).
158

16-
Comments on GitHub issues or pull requests should add content to the discussions.
17-
Approbation comments such as *+1* or *I would like this feature to be implemented as well*
18-
will be deleted by the maintainers. Please use
19-
[GitHub reactions](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments)
20-
instead.
9+
Comments on GitHub issues or pull requests should add content to the discussions. Approbation comments such as *+1* or *I would like this feature to be implemented as well* will be deleted by the maintainers. Please use [GitHub reactions](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments) instead.

.github/PULL_REQUEST_TEMPLATE.md

+3-11
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,7 @@
11
Thanks for your interest in plotly.js!
22

3-
Developers are strongly encouraged to first make a PR to their own plotly.js
4-
fork and ask one of the maintainers to review the modifications there. Once the
5-
pull request is deemed satisfactory, the developer will be asked to make a pull
6-
request to the main plotly.js repo and may be asked to squash some commits
7-
before doing so.
3+
Developers are strongly encouraged to first make a PR to their own plotly.js fork and ask one of the maintainers to review the modifications there. Once the pull request is deemed satisfactory, the developer will be asked to make a pull request to the main plotly.js repo and may be asked to squash some commits before doing so.
84

9-
Developers should `git rebase` their local branch off the latest `master` before
10-
opening a pull request.
5+
Developers should `git rebase` their local branch off the latest `master` before opening a pull request.
116

12-
Note that it is forbidden to force push (i.e. `git push -f`) to remote branches
13-
associated with opened pull requests. Force pushes make it hard for maintainers
14-
to keep track of updates. Therefore, if required, please
15-
`git merge master` into your PR branch instead of `git rebase master`.
7+
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`.

CONTRIBUTING.md

+2-31
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,11 @@
22

33
## Opening issues
44

5-
Search for existing and closed issues. If your problem or idea is not addressed
6-
yet, [please open a new issue](https://github.com/plotly/plotly.js/issues/new).
7-
8-
Bug reports must be accompanied with a reproducible example. We recommend using
9-
[codepen](http://codepen.io/), [jsfiddle](https://jsfiddle.net/) or
10-
[jsbin](https://jsbin.com) to share your example.
11-
12-
Note that GitHub issues are reserved for bug reports and feature requests only.
13-
Implementation questions should be asked on
14-
community.plot.ly (tagged [`plotly-js`](http://community.plot.ly/c/plotly-js)) or on Stack Overflow (tagged
15-
[`plotly`](https://stackoverflow.com/questions/tagged/plotly)).
16-
17-
Comments on GitHub issues or pull requests should add content to the discussions.
18-
Approbation comments such as *+1* or *I would like this feature to be implemented as well*
19-
will be deleted by the maintainers. Please use
20-
[GitHub reactions](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments)
21-
instead.
5+
Please read the [issue guidelines](./.github/ISSUE_TEMPLATE.md).
226

237
## Making pull requests
248

25-
Developers are strongly encouraged to first make a PR to their own plotly.js
26-
fork and ask one of the maintainers to review the modifications there. Once the
27-
pull request is deemed satisfactory, the developer will be asked to make a pull
28-
request to the main plotly.js repo and may be asked to squash some commits
29-
before doing so.
30-
31-
Developers should `git rebase` their local branch off the latest `master` before
32-
opening a pull request.
33-
34-
Note that it is forbidden to force push (i.e. `git push -f`) to remote branches
35-
associated with opened pull requests. Force pushes make it hard for maintainers
36-
to keep track of updates. Therefore, if required, please
37-
`git merge master` into your PR branch instead of `git rebase master`.
38-
9+
Please read the [pull request guidelines](./.github/PULL_REQUEST_TEMPLATE.md).
3910

4011
## GitHub labels
4112

0 commit comments

Comments
 (0)