From 6cc5f5b39b2db2f6322f8b71f97b51cc647769c5 Mon Sep 17 00:00:00 2001 From: Ricky Reusser Date: Tue, 19 Jul 2016 13:20:53 -0400 Subject: [PATCH 1/2] Guideline cleanup --- .github/ISSUE_TEMPLATE.md | 19 ++++-------------- .github/PULL_REQUEST_TEMPLATE.md | 14 +++----------- CONTRIBUTING.md | 33 ++------------------------------ 3 files changed, 9 insertions(+), 57 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 5e7aac7b5ae..527aeefc9ca 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,20 +1,9 @@ Thanks for your interest in plotly.js! -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). +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). -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. +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. -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)). +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)). -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. +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. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 55883fdef7f..5d27f6d4caa 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,15 +1,7 @@ Thanks for your interest in plotly.js! -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. +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. -Developers should `git rebase` their local branch off the latest `master` before -opening a pull request. +Developers should `git rebase` their local branch off the latest `master` before opening a pull request. -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`. +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`. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e857af653ce..6e859d93500 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,40 +2,11 @@ ## Opening issues -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). - -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. - -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)). - -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. +Please read the [issue guidelines](./.github/ISSUE_TEMPLATE.md). ## Making pull requests -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. - -Developers should `git rebase` their local branch off the latest `master` before -opening a pull request. - -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`. - +Please read the [pull request guidelines](./.github/PULL_REQUEST_TEMPLATE.md) ## GitHub labels From 2d95b41e43401c82868423d1121ec4a041acece2 Mon Sep 17 00:00:00 2001 From: Ricky Reusser Date: Tue, 19 Jul 2016 13:23:09 -0400 Subject: [PATCH 2/2] Punctuation detail --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6e859d93500..e3841feb578 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ Please read the [issue guidelines](./.github/ISSUE_TEMPLATE.md). ## Making pull requests -Please read the [pull request guidelines](./.github/PULL_REQUEST_TEMPLATE.md) +Please read the [pull request guidelines](./.github/PULL_REQUEST_TEMPLATE.md). ## GitHub labels