mirror of https://github.com/fdehau/tui-rs
chore: improve contributing guidelines
* Improve issue templates and make them mandatory. * Improve CONTRIBUTING.md. * Add template for pull requests.pull/475/head
parent
b250825c38
commit
1028d39db0
@ -1,30 +1,60 @@
|
|||||||
---
|
---
|
||||||
name: Bug report
|
name: Bug report
|
||||||
about: Create a report to help us improve
|
about: Create an issue about a bug you encountered
|
||||||
title: ''
|
title: ''
|
||||||
labels: bug
|
labels: bug
|
||||||
assignees: ''
|
assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Describe the bug**
|
<!--
|
||||||
|
Hi there, sorry `tui` is not working as expected.
|
||||||
|
Please fill this bug report conscientiously.
|
||||||
|
A detailed and complete issue is more likely to be processed quickly.
|
||||||
|
-->
|
||||||
|
|
||||||
|
## Description
|
||||||
|
<!--
|
||||||
A clear and concise description of what the bug is.
|
A clear and concise description of what the bug is.
|
||||||
|
-->
|
||||||
|
|
||||||
|
|
||||||
|
## To Reproduce
|
||||||
|
<!--
|
||||||
|
Try to reduce the issue to a simple code sample exhibiting the problem.
|
||||||
|
Ideally, fork the project and add a test or an example.
|
||||||
|
-->
|
||||||
|
|
||||||
**To Reproduce**
|
|
||||||
If possible include a code sample exhibiting the problem.
|
|
||||||
|
|
||||||
**Expected behavior**
|
## Expected behavior
|
||||||
|
<!--
|
||||||
A clear and concise description of what you expected to happen.
|
A clear and concise description of what you expected to happen.
|
||||||
|
-->
|
||||||
|
|
||||||
|
|
||||||
|
## Screenshots
|
||||||
|
<!--
|
||||||
|
If applicable, add screenshots, gifs or videos to help explain your problem.
|
||||||
|
-->
|
||||||
|
|
||||||
|
|
||||||
**Screenshots**
|
## Environment
|
||||||
If applicable, add screenshots to help explain your problem.
|
<!--
|
||||||
|
Add a description of the systems where you are observing the issue. For example:
|
||||||
|
- OS: Linux
|
||||||
|
- Terminal Emulator: xterm
|
||||||
|
- Font: Inconsolata (Patched)
|
||||||
|
- Crate version: 0.7
|
||||||
|
- Backend: termion
|
||||||
|
-->
|
||||||
|
|
||||||
**Desktop (please complete the following information):**
|
- OS:
|
||||||
- OS: [e.g. Linux,Windows]
|
- Terminal Emulator:
|
||||||
- Terminal Emulator [e.g xterm, Konsole, Terminal, iTerm2, ConEmu]
|
- Font:
|
||||||
- Font [e.g Inconsolata, Monospace]
|
- Crate version:
|
||||||
- Crate version [e.g. 0.7]
|
- Backend:
|
||||||
- Backend [e.g termion, crossterm]
|
|
||||||
|
|
||||||
**Additional context**
|
## Additional context
|
||||||
|
<!--
|
||||||
Add any other context about the problem here.
|
Add any other context about the problem here.
|
||||||
|
If you already looked into the issue, include all the leads you have explored.
|
||||||
|
-->
|
||||||
|
@ -0,0 +1 @@
|
|||||||
|
blank_issues_enabled: false
|
@ -0,0 +1,17 @@
|
|||||||
|
## Description
|
||||||
|
<!--
|
||||||
|
A clear and concise description of what this PR changes.
|
||||||
|
-->
|
||||||
|
|
||||||
|
## Testing guidelines
|
||||||
|
<!--
|
||||||
|
A clear and concise description of how the changes can be tested.
|
||||||
|
For example, you can include a command to run the relevant tests or examples.
|
||||||
|
You can also include screenshots of the expected behavior.
|
||||||
|
-->
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
|
||||||
|
* [ ] I have read the [contributing guidelines](../CONTRIBUTING.md).
|
||||||
|
* [ ] I have added relevant tests.
|
||||||
|
* [ ] I have documented all new additions.
|
Loading…
Reference in New Issue