From 95acb31dfc2d3e1365d2314b42ccab420accdc0a Mon Sep 17 00:00:00 2001 From: Tomas Della Vedova Date: Wed, 13 Mar 2019 19:12:11 +0100 Subject: [PATCH] Added pull request and issue templates (#776) --- .github/ISSUE_TEMPLATE.md | 10 ++++++ .github/ISSUE_TEMPLATE/bug.md | 41 ++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature.md | 22 +++++++++++++ .github/ISSUE_TEMPLATE/question.md | 10 ++++++ .github/ISSUE_TEMPLATE/regression.md | 47 ++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/security.md | 6 ++++ .github/PULL_REQUEST_TEMPLATE.md | 11 +++++++ 7 files changed, 147 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/feature.md create mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/ISSUE_TEMPLATE/regression.md create mode 100644 .github/ISSUE_TEMPLATE/security.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..0a2ad2dec --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,10 @@ +## 👉 [Please follow one of these issue templates](https://github.com/elastic/elasticsearch-js/issues/new/choose) 👈 + +#### You have already researched for similar issues? +It's not uncommon that somebody already opened an issue or in the best case it's already fixed but not merged. That's the reason why you should [search](https://github.com/elastic/elasticsearch-js/issues) at first before submitting a new one. + +#### Are you sure this is an issue with @elastic/elasticsearch or are you just looking for some help? + +Issues should only be posted in this repository after you have been able to reproduce them and confirm that they are a bug or incorrect/missing information in the [docs](https://github.com/elastic/elasticsearch-js/docs). + +If you have a question related to Elasticsearch itself, please consider open a question on [discuss.elastic.co](https://discuss.elastic.co/). diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 000000000..620b6a5ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,41 @@ +--- +name: 🐛 Bug report +about: Create a report to help us improve +--- + +It's not uncommon that somebody already opened an issue or in the best case it's already fixed but not merged. That's the reason why you should [search](https://github.com/elastic/elasticsearch-js/issues) at first before submitting a new one. + +**Please read this entire template before posting any issue. If you ignore these instructions +and post an issue here that does not follow the instructions, your issue might be closed, +locked, and assigned the `not reproducible` label.** + +## 🐛 Bug Report + +A clear and concise description of what the bug is. + +## To Reproduce + +Steps to reproduce the behavior: + +Paste your code here: + +```js + +``` + +## Expected behavior + +A clear and concise description of what you expected to happen. + +Paste the results here: + +```js + +``` + +## Your Environment + +- *node version*: 6,8,10 +- *@elastic/elasticsearch version*: >=7.0.0 +- *os*: Mac, Windows, Linux +- *any other relevant information* diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md new file mode 100644 index 000000000..2335d551d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -0,0 +1,22 @@ +--- +name: 🚀 Feature Proposal +about: Submit a proposal for a new feature +--- + +It's not uncommon that somebody already opened an issue or in the best case it's already fixed but not merged. That's the reason why you should [search](https://github.com/elastic/elasticsearch-js/issues) at first before submitting a new one. + +**Please read this entire template before posting any issue. If you ignore these instructions +and post an issue here that does not follow the instructions, your issue might be closed, +locked, and assigned the `invalid` label.** + +## 🚀 Feature Proposal + +A clear and concise description of what the feature is. + +## Motivation + +Please outline the motivation for the proposal. + +## Example + +Please provide an example for how this feature would be used. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 000000000..bbd7143bc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,10 @@ +--- +name: 💬 Questions / Help +about: If you have questions, please check our Gitter or Help repo +--- + +## 💬 Questions and Help + +### Please note that this issue tracker is not a help forum and this issue may be closed. + +It's not uncommon that somebody already opened an issue or in the best case it's already fixed but not merged. That's the reason why you should [search](https://github.com/elastic/elasticsearch-js/issues) at first before submitting a new one. diff --git a/.github/ISSUE_TEMPLATE/regression.md b/.github/ISSUE_TEMPLATE/regression.md new file mode 100644 index 000000000..079234a36 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/regression.md @@ -0,0 +1,47 @@ +--- +name: 💥 Regression Report +about: Report unexpected behavior that worked in previous versions +--- + +It's not uncommon that somebody already opened an issue or in the best case it's already fixed but not merged. That's the reason why you should [search](https://github.com/elastic/elasticsearch-js/issues) at first before submitting a new one. + +**Please read this entire template before posting any issue. If you ignore these instructions +and post an issue here that does not follow the instructions, your issue might be closed, +locked, and assigned the `invalid` label.** + +## 💥 Regression Report + +A clear and concise description of what the regression is. + +## Last working version + +Worked up to version: + +Stopped working in version: + +## To Reproduce + +Steps to reproduce the behavior: + +Paste your code here: + +```js + +``` + +## Expected behavior + +A clear and concise description of what you expected to happen. + +Paste the results here: + +```js + +``` + +## Your Environment + +- *node version*: 6,8,10 +- *@elastic/elasticsearch version*: >=7.0.0 +- *os*: Mac, Windows, Linux +- *any other relevant information* diff --git a/.github/ISSUE_TEMPLATE/security.md b/.github/ISSUE_TEMPLATE/security.md new file mode 100644 index 000000000..0529296fc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/security.md @@ -0,0 +1,6 @@ +--- +name: 👮 Security Issue +about: Responsible Disclosure +--- + +If you want to report a security issue, please take a look at [elastic/security](https://www.elastic.co/community/security). diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..bd9abd6e6 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,11 @@ +