From ce7a9073e107e60fc2ab4dbb02e20bddce34d595 Mon Sep 17 00:00:00 2001 From: Quentin de Quelen Date: Thu, 18 Jun 2020 11:09:00 +0200 Subject: [PATCH] Adding a tracking issue template --- .github/ISSUE_TEMPLATE/tracking-issue.md | 40 ++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/tracking-issue.md diff --git a/.github/ISSUE_TEMPLATE/tracking-issue.md b/.github/ISSUE_TEMPLATE/tracking-issue.md new file mode 100644 index 000000000..346dc487c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/tracking-issue.md @@ -0,0 +1,40 @@ +--- +name: Tracking issue +about: Template for a tracking issue +title: '' +labels: tracking-issue +assignees: '' + +--- + +# Summary + +One paragraph to explain the feature. + +# Motivations + +Why are we doing this? What use cases does it support? What is the expected outcome? + +# Explanation + +Explain the proposal like it was the final documentation of this proposal. + +- What is changing for end-users. +- How it works. +- What is breaking? +- Examples. + +# Implementation + +Explain the technical specificities that will need to be known or done in order to implement this proposal. + +## Steps + +Describe each step to create the feature with it's associated issue/PR. + +# Related + +- [ ] Validated by the team (@people needed) +- [ ] Test added +- [ ] [Documentation](https://github.com/meilisearch/documentation/issues/#xxx) //Change xxx or remove the line +- [ ] [SDK/Integrations](https://github.com/meilisearch/integration-guides/issues/#xxx) //Change xxx or remove the line