docs(project): add github templates

This commit is contained in:
Orhun Parmaksız 2022-02-22 16:07:25 +03:00
parent 323dcd9257
commit 74837a51bd
No known key found for this signature in database
GPG key ID: F83424824B3E4B90
3 changed files with 84 additions and 0 deletions

34
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View file

@ -0,0 +1,34 @@
---
name: Bug report
about: Report a bug to help us improve
title: ""
labels: "bug"
assignees: "orhun"
---
**Describe the bug**
<!--- A clear and concise description of what the bug is. -->
**To reproduce**
<!---
Steps to reproduce the behavior:
1. Build with '...' arguments
2. Run with '....' arguments
3. Press '....' keys
4. See error
-->
**Expected behavior**
<!--- A clear and concise description of what you expected to happen. -->
**Screenshots / Logs**
<!--- If applicable, add screenshots to help explain your problem. -->
**Software information**
<!--- Please fill the following fields -->
- Operating system: <!--- e.g. Arch GNU/Linux x86_64 5.4.8-arch1-1 -->
- Rust version: <!--- e.g. rustc 1.60.0-nightly (e789f3a3a 2022-02-11) -->
- Project version: <!--- e.g. 0.1.0 -->
**Additional context**
<!--- Add any other context about the problem here. -->

View file

@ -0,0 +1,19 @@
---
name: Feature request
about: Make a suggestion for the project
title: ""
labels: "enhancement"
assignees: "orhun"
---
**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. -->

View file

@ -0,0 +1,31 @@
## Description
<!--- Describe your changes in detail -->
## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->
## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->
## Screenshots / Logs (if applicable)
## Types of Changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- [ ] Documentation (no code change)
- [ ] Refactor (refactoring production code)
- [ ] Other <!--- (provide information) -->
## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
- [ ] My code follows the code style of this project.
- [ ] I have updated the documentation accordingly.
- [ ] I have formatted the code with [rustfmt](https://github.com/rust-lang/rustfmt).
- [ ] I checked the lints with [clippy](https://github.com/rust-lang/rust-clippy).
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.