Add PR template
This commit is contained in:
parent
b60cdcdf06
commit
e4f6ae2854
1 changed files with 29 additions and 0 deletions
29
.github/pull_request_template.md
vendored
Normal file
29
.github/pull_request_template.md
vendored
Normal file
|
@ -0,0 +1,29 @@
|
||||||
|
Please follow this template, if applicable.
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
Provide a short description of the changes your PR introduces.
|
||||||
|
This includes the actual feature you are adding,
|
||||||
|
as well as any other relevant additions that where necessary to implement your feature.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
When adding a widget or anything else that affects the configuration,
|
||||||
|
please provide a minimal example configuration snippet showcasing how to use it and
|
||||||
|
|
||||||
|
### Showcase
|
||||||
|
|
||||||
|
When adding widgets, please provide screenshots showcasing how your widget looks.
|
||||||
|
This is not strictly required, but strongly appreciated.
|
||||||
|
|
||||||
|
## Additional Notes
|
||||||
|
|
||||||
|
Anything else you want to add, such as remaining questions or explainations.
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
|
||||||
|
Please make sure you can check all the boxes that apply to this PR.
|
||||||
|
|
||||||
|
- [ ] All widgets I've added are correctly documented.
|
||||||
|
- [ ] The documentation in the `docs/content/main` directory has been adjusted to reflect my changes.
|
||||||
|
- [ ] I used `cargo fmt` to automatically format all code before committing
|
Loading…
Add table
Reference in a new issue