diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..433fb9ef7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,26 @@ +--- +name: Bug report +about: Found a bug? Help us squash it! +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**System information** +* CPU architecture: +* Distribution and kernel version: +* SELinux on?: +* Any other system details we should know?: + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..8a8486365 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,16 @@ +--- +name: Feature request +about: Help us develop our roadmap and direction. +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/something-else.md b/.github/ISSUE_TEMPLATE/something-else.md new file mode 100644 index 000000000..7ce0a3489 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/something-else.md @@ -0,0 +1,6 @@ +--- +name: Something Else +about: Just give me a text box! +--- + + diff --git a/.github/PULL_REQUEST_TEMPLATE/bug_fix.md b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md new file mode 100644 index 000000000..a24a4c23c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md @@ -0,0 +1,21 @@ +--- +name: Bug fix +about: A bug squashed. + +--- + +**Related bugs:** +This bug fix closes issue #???. + +**Description of problem:** +Describe what was causing the related issue to happen. + +**Description of solution:** +Describe the rationale behind the fix. + +**Checklist:** +The CI will check all of these, but you'll need to have done them: + +* [ ] `cargo fmt -- --check` passes. +* [ ] `cargo +nightly clippy` has no warnings. +* [ ] `cargo test` passes. diff --git a/.github/PULL_REQUEST_TEMPLATE/feature.md b/.github/PULL_REQUEST_TEMPLATE/feature.md new file mode 100644 index 000000000..e43e06a85 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/feature.md @@ -0,0 +1,24 @@ +--- +name: Feature +about: The dawn of a new era. + +--- + +**Related features:** +This feature resolves issue #???. + +**Description of feature:** +A short description of the feature implemented. + +**Implementation:** +Describe any pieces of the implementation that deserve further explanation. +Detail any gotchas, uncertainties, or open questions about the implementation. + +**Checklist:** + +The CI will check all of these, but you'll need to have done them: + +* [ ] `cargo fmt -- --check` passes. +* [ ] `cargo +nightly clippy` has no warnings. +* [ ] `cargo test` passes. + diff --git a/.github/PULL_REQUEST_TEMPLATE/something-else.md b/.github/PULL_REQUEST_TEMPLATE/something-else.md new file mode 100644 index 000000000..afaab254b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/something-else.md @@ -0,0 +1,7 @@ +--- +name: Something Else +about: Just give me a text box! + +--- + +