diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..04aae67 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,24 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..11fc491 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +**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. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..142cc1d --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,42 @@ +# Objective + +- Describe the objective or issue this PR addresses. +- If you're fixing a specific issue, say "Fixes #X". + +## Solution + +- Describe the solution used to achieve the objective above. + +## Testing + +- Did you test these changes? If so, how? +- Are there any parts that need more testing? + +--- + +## Showcase + +> This section is optional. If this PR does not include a visual change or does not add a new feature, you can delete this section. + +- Help others understand the result of this PR by showcasing your awesome work! +- If this PR adds a new feature or public API, consider adding a brief pseudo-code snippet of it in action +- If this PR includes a visual change, consider adding a screenshot, GIF, or video + - If you want, you could even include a before/after comparison! +- If the Migration Guide adequately covers the changes, you can delete this section + +While a showcase should aim to be brief and digestible, you can use a toggleable section to save space on longer showcases: + +
+ Click to view showcase + +```rust +println!("My super cool code."); +``` + +
+ +## To-Do Checklist + +- [ ] Write CHANGELOG.md +- [ ] Update Cargo.lock (If this is not a migration PR nor changing any dependencies, you may remove this) +- [ ] Update supported version in README.md (If this is not a release PR, you may remove this) diff --git a/CHANGELOG.md b/CHANGELOG.md index 34022ef..a257160 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,12 +7,6 @@ - Systems now expected `TimeCtx` generic parameter by [#15](https://github.com/Multirious/bevy_time_runner/pull/15) - `TimeRunnerPlugin` now expected `TimeCtx` generic parameter by [#19](https://github.com/Multirious/bevy_time_runner/pull/19) -- Migrate to bevy 0.18 by [#16](https://github.com/Multirious/bevy_time_runner/pull/16) -- Update flake by [#17](https://github.com/Multirious/bevy_time_runner/pull/17) - - Use latest instead of a version for stableRust in flake.nix - - `nix flake update` - - Remove flake-utils dependency from flake.nix - - Systems can now be registered in non-default time context. (Virtual, Fixed, and/or Real) See [#15](https://github.com/Multirious/bevy_time_runner/pull/15) for more details. Notably: @@ -21,6 +15,15 @@ - `TimeContext` is automatically inserted to children of `TimeRunner`. - Add feature `debug`. This adds `TimeRunnerDebugPlugin` which logs warnings on missing `TimeContext` marker component when enabled. +- Migrate to bevy 0.18 by [#16](https://github.com/Multirious/bevy_time_runner/pull/16) + +Internal: +- Update issue and PR template by [#21](https://github.com/Multirious/bevy_time_runner/pull/21) +- Update flake by [#17](https://github.com/Multirious/bevy_time_runner/pull/17) + - Use latest instead of a version for stableRust in flake.nix + - `nix flake update` + - Remove flake-utils dependency from flake.nix + ## v0.5.2 - 2025-10-6 - Fix documentation