diff --git a/.github/ISSUE_TEMPLATE/Bug.md b/.github/ISSUE_TEMPLATE/Bug.md new file mode 100644 index 000000000..66163c9f5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug.md @@ -0,0 +1,56 @@ +--- +name: Bug +about: Report a bug related to the project. +labels: bug +--- + +Revealed from + +Caused by + +Related to + + + + + + +## Summary + + + + + + +## Steps to reproduce + + + + + + +## What is the current _bug_ behavior? + + + + + + +## What is the expected _correct_ behavior? + + + + + + +## Relevant logs and/or screenshots + + + + + + +## Possible fixes + + + diff --git a/.github/ISSUE_TEMPLATE/Feature proposal.md b/.github/ISSUE_TEMPLATE/Feature proposal.md new file mode 100644 index 000000000..fe6bb7314 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Feature proposal.md @@ -0,0 +1,48 @@ +--- +name: Feature proposal +about: Suggest a new feature for the project. +labels: feature +--- + +Revealed from + +Related to + + + + + + +## Problem to solve + + + + + + +## Proposal + + + + + + +## Prior art + + + + + + + +## Alternatives + + + + + + +## Links & references + + + diff --git a/.github/ISSUE_TEMPLATE/Question.md b/.github/ISSUE_TEMPLATE/Question.md new file mode 100644 index 000000000..899173ed2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Question.md @@ -0,0 +1,23 @@ +--- +name: Question +about: Ask a question related to the project. +labels: question +--- + +Related to + + + + + + +## Background + + + + + + +## Question + + diff --git a/.github/ISSUE_TEMPLATE/Roadmap.md b/.github/ISSUE_TEMPLATE/Roadmap.md new file mode 100644 index 000000000..a1af203dc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Roadmap.md @@ -0,0 +1,25 @@ +--- +name: Roadmap +about: Provide a roadmap for reaching a milestone or implementing a big feature. +labels: roadmap +--- + +Related to + + + + + + +## Summary + + + + + + +## Roadmap + + + +- [ ] 1. First step. () diff --git a/.github/ISSUE_TEMPLATE/Task.md b/.github/ISSUE_TEMPLATE/Task.md new file mode 100644 index 000000000..eb0810c20 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Task.md @@ -0,0 +1,38 @@ +--- +name: Task +about: Describe a task to be done. +--- + +Part of + +Revealed from + +Required for + +Requires + +Related to + + + + + + +## Background + + + + + + +## Problem to solve + + + + + + +## Possible solutions + + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..97fd23686 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,70 @@ +--- +name: Task +about: Perform a task related to the project. +--- + + + + + + + + + + +Resolves + +Part of + +Required for + +Requires + +Related to + + + + + + +## Synopsis + + + + + + +## Solution + + + + + + +## Checklist + +- Created PR: + - [ ] In [draft mode][l:1] + - [ ] Name contains `WIP: ` prefix + - [ ] Name contains issue reference + - [ ] Has `k: ` labels applied + - [ ] Has assignee +- [ ] Documentation is updated (if required) +- [ ] Tests are updated (if required) +- [ ] Changes conform code style +- [ ] CHANGELOG entry is added (if required) +- [ ] FCM (final commit message) is posted + - [ ] and approved +- [ ] [Review][l:2] is completed and changes are approved +- Before merge: + - [ ] Milestone is set + - [ ] PR's name and description are correct and up-to-date + - [ ] `WIP: ` prefix is removed + - [ ] All temporary labels are removed + + + + + +[l:1]: https://help.github.com/en/articles/about-pull-requests#draft-pull-requests +[l:2]: https://help.github.com/en/articles/reviewing-changes-in-pull-requests diff --git a/.github/PULL_REQUEST_TEMPLATE/Bugfix.md b/.github/PULL_REQUEST_TEMPLATE/Bugfix.md new file mode 100644 index 000000000..98683ec2e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/Bugfix.md @@ -0,0 +1,55 @@ +--- +name: Bug +about: Resolve a bug related to the project. +labels: enhancement +--- + + + + +Resolves + + + + +## Synopsis + + + + + + +## Solution + + + + + + +## Checklist + +- Created PR: + - [ ] In [draft mode][l:1] + - [ ] Name contains `WIP: ` prefix + - [ ] Name contains issue reference + - [ ] Has `k: ` labels applied + - [ ] Has assignee +- [ ] Documentation is updated (if required) +- [ ] Tests are updated (if required) +- [ ] Changes conform code style +- [ ] CHANGELOG entry is added (if required) +- [ ] FCM (final commit message) is posted + - [ ] and approved +- [ ] [Review][l:2] is completed and changes are approved +- Before merge: + - [ ] Milestone is set + - [ ] PR's name and description are correct and up-to-date + - [ ] `WIP: ` prefix is removed + - [ ] All temporary labels are removed + + + + + +[l:1]: https://help.github.com/en/articles/about-pull-requests#draft-pull-requests +[l:2]: https://help.github.com/en/articles/reviewing-changes-in-pull-requests diff --git a/.github/PULL_REQUEST_TEMPLATE/Release.md b/.github/PULL_REQUEST_TEMPLATE/Release.md new file mode 100644 index 000000000..a926ddfec --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/Release.md @@ -0,0 +1,41 @@ +--- +name: Release +about: Prepare a new release of the project. +labels: enhancement, k: documentation +--- + + + + +Prepares []() release. + + + + +## Checklist + +- Created PR: + - [ ] In [draft mode][l:1] + - [ ] Name contains `WIP: ` prefix + - [ ] Name contains issue reference + - [ ] Has `k: ` labels applied + - [ ] Has assignee +- [ ] Documentation is updated (if required) +- [ ] Tests are updated (if required) +- [ ] Changes conform code style +- [ ] CHANGELOG entry is added (if required) +- [ ] FCM (final commit message) is posted + - [ ] and approved +- [ ] [Review][l:2] is completed and changes are approved +- Before merge: + - [ ] Milestone is set + - [ ] PR's name and description are correct and up-to-date + - [ ] `WIP: ` prefix is removed + - [ ] All temporary labels are removed + + + + + +[l:1]: https://help.github.com/en/articles/about-pull-requests#draft-pull-requests +[l:2]: https://help.github.com/en/articles/reviewing-changes-in-pull-requests diff --git a/.github/PULL_REQUEST_TEMPLATE/Roadmap.md b/.github/PULL_REQUEST_TEMPLATE/Roadmap.md new file mode 100644 index 000000000..fec346dc9 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/Roadmap.md @@ -0,0 +1,57 @@ +--- +name: Roadmap +about: Provide a roadmap for implementing a big feature. +labels: roadmap +--- + + + + +Resolves + +Required for + +Related to + + + + + + +## Summary + + + + + + +## Roadmap + + + +- [ ] 1. First step. () + + + + +## Checklist + +- Created PR: + - [ ] In [draft mode][l:1] + - [ ] Name contains `WIP: ` prefix + - [ ] Name contains issue reference + - [ ] Has `k: ` labels applied + - [ ] Has assignee +- [ ] [Review][l:2] is completed and changes are approved +- Before merge: + - [ ] Milestone is set + - [ ] PR's name and description are correct and up-to-date + - [ ] `WIP: ` prefix is removed + - [ ] All temporary labels are removed + + + + + +[l:1]: https://help.github.com/en/articles/about-pull-requests#draft-pull-requests +[l:2]: https://help.github.com/en/articles/reviewing-changes-in-pull-requests