diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..5babb31 --- /dev/null +++ b/.github/pull_request_template.md @@ -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