Skip to content
This repository has been archived by the owner on Aug 25, 2021. It is now read-only.

Commit

Permalink
Add issue and PR templates
Browse files Browse the repository at this point in the history
  • Loading branch information
tyranron committed May 23, 2019
1 parent 55ca927 commit bc5cb78
Show file tree
Hide file tree
Showing 9 changed files with 413 additions and 0 deletions.
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
name: Bug
about: Report a bug related to the project.
labels: bug
---

Revealed from <paste issue/PR reference>
<and/or>
Caused by <paste issues/PRs references>
<and/or>
Related to <paste issues/PRs references>

<Remove the lines above if there are no related issues/PRs>




## Summary

<Summarize the bug encountered concisely>




## Steps to reproduce

<How one can reproduce the issue - this is very important>




## What is the current _bug_ behavior?

<What actually happens>




## What is the expected _correct_ behavior?

<What you should see instead>




## Relevant logs and/or screenshots

<Paste any relevant logs - please use code blocks (`````) to format console output, logs, and code as it's very hard to read otherwise>
<If there is no logs/screenshots - just remove this section completely>



## Possible fixes

<If you can, link to the line of code that might be responsible for the problem>
<If there is nothing to propose - just remove this section completely>
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature proposal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
name: Feature proposal
about: Suggest a new feature for the project.
labels: feature
---

Revealed from <paste issues/PRs references>
<and/or>
Related to <paste issues/PRs references>

<Remove the lines above if there are no related issues/PRs>




## Problem to solve

<Describe the problem that feature is going to solve>




## Proposal

<Give a detailed proposal of problem solving, describe its pros and cons>




## Prior art

<Provide a link and brief info about attempts and proposals which tried to solve this problem before, or are quite relative to this proposal>
<If there is nothing to refer - just remove this section completely>




## Alternatives

<Provide a brief description of alternative solutions, describe their pros and cons>




## Links & references

<Provide links and references that are related to this proposal and problem>
<If there is nothing to refer - just remove this section completely>
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/Question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Question
about: Ask a question related to the project.
labels: question
---

Related to <paste issues/PRs references>

<Remove the lines above if there are no related issues/PRs>




## Background

<Describe the preconditions and the situation which lead to your question>




## Question

<Ask the concrete question (or multiple questions)>
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/Roadmap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Roadmap
about: Provide a roadmap for reaching a milestone or implementing a big feature.
labels: roadmap
---

Related to <paste issues/PRs references>

<Remove the lines above if there are no related issues/PRs>




## Summary

<Summarize the meaning and the purpose of this roadmap>




## Roadmap

<Describe the roadmap as a numbered task list, where each step should contain references to its issue/PR and checked after its completion>

- [ ] 1. First step. (<paste issue/PR references>)
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/Task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Task
about: Describe a task to be done.
---

Part of <paste issue/PR reference>
<and/or>
Revealed from <paste issue/PR reference>
<and/or>
Required for <paste issues/PRs references>
<and/or>
Requires <paste issues/PRs references>
<and/or>
Related to <paste issues/PRs references>

<Remove the lines above if there are no related issues/PRs>




## Background

<Describe the preconditions and the situation which lead to the problem>




## Problem to solve

<Describe the problem to be solved by this task>




## Possible solutions

<Describe possible solutions and assumptions about them>
<If there is nothing to propose - just remove this section completely>
70 changes: 70 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
name: Task
about: Perform a task related to the project.
---

<To use "Bugfix" PR template add `&template=Bugfix.md` to this page's URL>

<To use "Roadmap" PR template add `&template=Roadmap.md` to this page's URL>

<To use "Release" PR template add `&template=Release.md` to this page's URL>

<Remove everything above before submitting this PR>


Resolves <paste issue reference>
<and/or>
Part of <paste issue/PR reference>
<and/or>
Required for <paste issues/PRs references>
<and/or>
Requires <paste issues/PRs references>
<and/or>
Related to <paste issues/PRs references>

<Remove the lines above if there are no related issues/PRs>




## Synopsis

<Give a brief overview of the problem>




## Solution

<Describe how exactly the problem is (or will be) resolved>




## 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
55 changes: 55 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/Bugfix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
name: Bug
about: Resolve a bug related to the project.
labels: enhancement
---

<Remove everything above before submitting this PR>


Resolves <paste issue reference>




## Synopsis

<Give a brief overview of the problem>




## Solution

<Describe how exactly the problem is (or will be) resolved>




## 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
41 changes: 41 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/Release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: Release
about: Prepare a new release of the project.
labels: enhancement, k: documentation
---

<Remove everything above before submitting this PR>


Prepares [<paste release version>](<paste milestone link>) 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
Loading

0 comments on commit bc5cb78

Please sign in to comment.