chore: improve contributing guidelines

* Improve issue templates and make them mandatory.
* Improve CONTRIBUTING.md.
* Add template for pull requests.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,30 +1,60 @@
 ---
 name: Bug report
-about: Create a report to help us improve
+about: Create an issue about a bug you encountered
 title: ''
 labels: bug
 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.
+-->
+
+
+## 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.
+-->
+
+
+## Screenshots
+<!--
+If applicable, add screenshots, gifs or videos to help explain your problem.
+-->
+
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+## Environment
+<!--
+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: [e.g. Linux,Windows]
- - Terminal Emulator [e.g xterm, Konsole, Terminal, iTerm2, ConEmu]
- - Font [e.g Inconsolata, Monospace]
- - Crate version [e.g. 0.7]
- - Backend [e.g termion, crossterm]
+- OS:
+- Terminal Emulator:
+- Font:
+- Crate version:
+- Backend:
 
-**Additional context**
+## Additional context
+<!--
 Add any other context about the problem here.
+If you already looked into the issue, include all the leads you have explored.
+-->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature_request.md

@@ -7,14 +7,26 @@ assignees: ''
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
+## Problem
+<!--
 A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+-->
 
-**Describe the solution you'd like**
+## Solution
+<!--
 A clear and concise description of what you want to happen.
+Things to consider:
+- backward compatibility
+- ease of use of the API (https://rust-lang.github.io/api-guidelines/)
+- consistency with the rest of the crate
+-->
 
-**Describe alternatives you've considered**
+## Alternatives
+<!--
 A clear and concise description of any alternative solutions or features you've considered.
+-->
 
-**Additional context**
+## Additional context
+<!--
 Add any other context or screenshots about the feature request here.
+-->

.github/pull_request_template.md

@@ -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.

CONTRIBUTING.md

@@ -1,12 +1,21 @@
 # Contributing
 
+## Building
+
 [cargo-make]: https://github.com/sagiegurari/cargo-make "cargo-make"
 
-`tui` is an ordinary Rust project where common tasks are managed with [cargo-make]. It wraps common
-`cargo` commands with sane defaults depending on your platform of choice. Bulding the project should
-be as easy as running `cargo make`.
+`tui` is an ordinary Rust project where common tasks are managed with [cargo-make].
+It wraps common `cargo` commands with sane defaults depending on your platform of choice.
+Building the project should be as easy as running `cargo make build`.
+
+## :hammer_and_wrench: Pull requests
+
+All contributions are obviously welcome.
+Please include as many details as possible in your PR description to help the reviewer (follow the provided template).
+Make sure to highlight changes which may need additional attention or you are uncertain about.
+Any idea with a large scale impact on the crate or its users should ideally be discussed in a "Feature Request" issue beforehand.
 
-## Continous Integration
+## Continuous Integration
 
 We use Github Actions for the CI where we perform the following checks:
 - The code should compile on `stable` and the Minimum Supported Rust Version (MSRV).
@@ -14,13 +23,11 @@ We use Github Actions for the CI where we perform the following checks:
 - The code should conform to the default format enforced by `rustfmt`.
 - The code should not contain common style issues `clippy`.
 
-You can also check most of those things yourself locally using `cargo make ci` which will offer you
-a shorter feedback loop.
+You can also check most of those things yourself locally using `cargo make ci` which will offer you a shorter feedback loop.
 
 ## Tests
 
-The test coverage of the crate is far from being ideal but we already have a fair amount of tests in
-place. Beside the usal doc and unit tests, one of the most valuable test you can write for `tui` is
-a test again the `TestBackend` which allows you to assert the content of the output buffer that
-would have been flushed to the termminal after a given draw call (see `widgets_block_renders` in
-[tests/widgets_block.rs](./tests/widget_block.rs) for an example).
+The test coverage of the crate is far from being ideal but we already have a fair amount of tests in place.
+Beside the usual doc and unit tests, one of the most valuable test you can write for `tui` is a test again the `TestBackend`.
+It allows you to assert the content of the output buffer that would have been flushed to the terminal after a given draw call.
+See `widgets_block_renders` in [tests/widgets_block.rs](./tests/widget_block.rs) for an example.