From a0e00bf81d01281ffd795031fd9940fad0848d9e Mon Sep 17 00:00:00 2001 From: Haoran Fang Date: Sat, 19 Jul 2025 22:54:22 +1000 Subject: [PATCH 1/8] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 71 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 75 +++++++++++++++++------ .github/ISSUE_TEMPLATE/pr-fix-template.md | 56 +++++++++++++++++ 3 files changed, 184 insertions(+), 18 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/pr-fix-template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..3e4b85d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,71 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: bug +assignees: '' + +--- + +--- +name: `Title` +about: `Report a bug.` +title: `"[BUG] "` +labels: `""` +assignees: `""` + +--- + +### Bug / Feature / Question + +> _Please complete the relevant sections. Incomplete issues may be closed._ + +--- + +### Description / Summary + +> _Clear and concise description of the issue, request, or question._ + +--- + +### Reproduction Steps + +> _Steps to trigger the bug. Provide the minimal setup._ + +1. +2. +3. + +--- + +### Expected vs Actual Behaviour + +- **Expected:** +- **Actual:** + +--- + +### Environment + +> _Provide environment details or leave `N/A`._ + +- GravLib Version: +- VEX Brain Firmware: +- Rust Version: +- Target Platform (e.g., VEX V5, PROS, RMS, VEXCode): +- Operating System: + +--- + +### Related Code / Logs + +> _Paste code snippets or error messages (use ``` for code blocks)._ + +```rust +// Example code +``` +--- + +### Other Comments? (optional) + +> _Are there other statements or comments you would like to make about this bug, feature or question?_ diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index fc14a8e..6d5223b 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -2,32 +2,71 @@ name: Feature request about: Suggest an idea for this project title: "[FEAT.]" -labels: '' +labels: enhancement assignees: '' --- --- -name: Feature Request -about: Suggest an idea for the project -title: "[FEATURE]" -labels: "enhancement" -assignees: "" +name: `Title` +about: `Request a feature.` +title: `"[Feat.] <title>"` +labels: `""` +assignees: `""` + +--- + +### Feature + +> _Please complete the relevant sections. Incomplete issues may be closed._ + +--- + +### Description / Summary + +> _Clear and concise description of the issue, request, or question._ + --- -#### Requested Feature -<!-- Concisely describe the behavior you are requesting here --> +### Current Implementation -<!-- Describe any details in point form here --> - - a - - b - - c +> _What implementation of your feature is already existing, or is your feature new (if this is the case, state `'No Current Implementation'`)_ + +--- -#### Current Implementation -<!-- Describe the current implementation here --> +### Feature Use Case + +> _Why do you need this feature? How would it be used?_ + +--- + +### Motivation + +> _What motivated you to create this feature?_ + +--- + +### Environment + +> _Provide environment details or leave `N/A`._ + +- GravLib Version: +- VEX Brain Firmware: +- Rust Version: +- Target Platform (e.g., VEX V5, PROS, RMS, VEXCode): +- Operating System: + +--- + +### Related Code / Logs + +> _Paste code snippets or error messages (use ``` for code blocks)._ + +```rust +// Example code +``` +--- -#### Motivation -<!-- Explain why this feature would benefit users and/or maintainers --> +### Other Comments? (optional) -#### (Optional) Possible Implementations and Alternatives -<!-- Describe any possible implementations or alternatives you have considered --> +> _Are there other statements or comments you would like to make about this feature?_ diff --git a/.github/ISSUE_TEMPLATE/pr-fix-template.md b/.github/ISSUE_TEMPLATE/pr-fix-template.md new file mode 100644 index 0000000..d86b17e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/pr-fix-template.md @@ -0,0 +1,56 @@ +--- +name: PR/Fix Template +about: Create a pull request or suggest a fix for this project +title: "[PR/Fix]" +labels: pullrequest +assignees: '' + +--- + +### Pull Request + +> *Thank you for contributing to GravLib! Please complete the checklist and fill out the relevant sections.* + +--- + +### Description + +> *Provide a short summary of what this PR changes, fixes, or adds.* + +--- + +### Checklist Before Submission + +- [ ] My PR addresses a **SINGLE** concern or feature. +- [ ] I **HAVE TESTED** the code and it compiles without warnings. +- [ ] I **HAVE NOT** broken existing public APIs. +- [ ] I **HAVE** documented new public APIs using Rustdoc comments. +- [ ] I **HAVE NOT** introduced compiler warnings. +- [ ] I **HAVE** checked that this PR passes existing unit tests. +- [ ] I **HAVE** added unit tests for any new functionality or bug fixes (if applicable). +- [ ] I **HAVE** not broken the continuous integration build. +- [ ] I **HAVE** avoided major architectural changes unless previously discussed. + +--- + +### What Was Changed + +> *Detailed explanation of the technical changes.* + +--- + +### Testing + +> *Describe how you tested this PR (unit tests, real hardware, simulation, etc.)* + +--- + +### Related Issues / PRs + +> *Reference related issues or pull requests, e.g. `Fixes #123`, `Related to #456`.* + +--- + +### Additional Notes + +> *Add any additional information, such as future work, limitations, or things to review closely.* From ababab7b9e62b172a47370eee9e65b175c7da76c Mon Sep 17 00:00:00 2001 From: Haoran Fang <ifh_fang.h@outlook.com> Date: Sun, 27 Jul 2025 15:33:45 +1000 Subject: [PATCH 2/8] Update pr-fix-template.md - added conditions in the checklist for V5 hardware - added a 'Breaking Changes' section - added requirement for describing/including outcome of tests and/or changes with a screenshot - if performance changes were impacted, needed to state --- .github/ISSUE_TEMPLATE/pr-fix-template.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/pr-fix-template.md b/.github/ISSUE_TEMPLATE/pr-fix-template.md index d86b17e..2022153 100644 --- a/.github/ISSUE_TEMPLATE/pr-fix-template.md +++ b/.github/ISSUE_TEMPLATE/pr-fix-template.md @@ -30,18 +30,29 @@ assignees: '' - [ ] I **HAVE** added unit tests for any new functionality or bug fixes (if applicable). - [ ] I **HAVE** not broken the continuous integration build. - [ ] I **HAVE** avoided major architectural changes unless previously discussed. +- [ ] I **HAVE** adhered to GravLib naming conventions. +- [ ] I **HAVE** tested on actual V5 hardware (if applicable). +- [ ] I **HAVE** verified memory usage is within V5 constraints. +- [ ] I **HAVE** checked compatibility with target VEX V5 brain firmware version. +- [ ] I **HAVE** verified real-time performance is not negatively impacted. --- ### What Was Changed -> *Detailed explanation of the technical changes.* +> *Detailed explanation of the technical changes. Include performance impacts if relevant, and include a screenshot or image if necessary.* + +--- + +### Breaking Changes + +> *List any breaking changes. If none, write "None".* --- ### Testing -> *Describe how you tested this PR (unit tests, real hardware, simulation, etc.)* +> *Describe how you tested this PR (unit tests, real hardware, simulation, etc.). If tested on hardware, specify which V5 components were used.* --- From 70ab509ba1f3752031d15fd415559786d4a7a75d Mon Sep 17 00:00:00 2001 From: Haoran Fang <ifh_fang.h@outlook.com> Date: Sun, 27 Jul 2025 15:53:49 +1000 Subject: [PATCH 3/8] Update feature-request.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - added V5 relevance - Added Proposed Solution with code example placeholder - Added Acceptance Criteria section for clear requirements - Better structured with logical flow from problem → solution → impact → timeline - Implementation Impact checklist covering performance, memory, and hardware compatibility - Priority/Urgency related to competition timelines - Specific Hardware field in the environment section - Renamed "Current Implementation" to "Alternatives Considered" --- .github/ISSUE_TEMPLATE/feature-request.md | 71 ++++++++++++++++++----- 1 file changed, 57 insertions(+), 14 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 6d5223b..005990a 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -7,15 +7,6 @@ assignees: '' --- ---- -name: `Title` -about: `Request a feature.` -title: `"[Feat.] <title>"` -labels: `""` -assignees: `""` - ---- - ### Feature > _Please complete the relevant sections. Incomplete issues may be closed._ @@ -34,15 +25,55 @@ assignees: `""` --- -### Feature Use Case +### Problem/Use Case + +> _What problem does this feature solve? How would it be used in a VEX robotics context?_ + +--- + +### Proposed Solutions + +> _Describe your ideal solution. Include code examples or API mockups if possible._ +> _For Example: ```// Example of how the feature might be used```_ + +--- + +### Alternatives Considered + +> _Describe any alternative solutions or workarounds you've considered. If none, write "None"._ + +--- + +### Competition Relevance + +> _Is this feature needed for competition use? Does it address common competition scenarios?_ + +- [ ] Critical for competition use +- [ ] Helpful for competition use +- [ ] General quality of life improvement +- [ ] Development/debugging tool + +--- + +### Implementation Impact -> _Why do you need this feature? How would it be used?_ +> _Consider the impact on the library (check all that apply):_ + +- [ ] This is a breaking change +- [ ] This may impact performance +- [ ] This may impact memory usage +- [ ] This requires new dependencies +- [ ] This affects hardware compatibility --- -### Motivation +### Priority/Urgency + +> _When do you need this feature?_ -> _What motivated you to create this feature?_ +- [ ] Before next competition season +- [ ] Nice to have soon +- [ ] No specific timeline --- @@ -54,7 +85,19 @@ assignees: `""` - VEX Brain Firmware: - Rust Version: - Target Platform (e.g., VEX V5, PROS, RMS, VEXCode): -- Operating System: +- Operating System: +- Specific Hardware (if applicable): + +--- + +### Acceptance Criteria + +> _What would make this feature complete? List specific requirements._ + +- [ ] [FILL: Criterion 1] +- [ ] [FILL: Criterion 2] +- [ ] e.g. Documentation updated +- [ ] e.g. Unit tests added --- From 1909a87fd6f1d719709c627a2c7d3e87a9d57d03 Mon Sep 17 00:00:00 2001 From: Haoran Fang <ifh_fang.h@outlook.com> Date: Sun, 27 Jul 2025 20:38:01 +1000 Subject: [PATCH 4/8] Update feature-request.md removed: - priority/urgency - environment - related code/logs --- .github/ISSUE_TEMPLATE/feature-request.md | 32 ----------------------- 1 file changed, 32 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 005990a..fed50d8 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -67,29 +67,6 @@ assignees: '' --- -### Priority/Urgency - -> _When do you need this feature?_ - -- [ ] Before next competition season -- [ ] Nice to have soon -- [ ] No specific timeline - ---- - -### Environment - -> _Provide environment details or leave `N/A`._ - -- GravLib Version: -- VEX Brain Firmware: -- Rust Version: -- Target Platform (e.g., VEX V5, PROS, RMS, VEXCode): -- Operating System: -- Specific Hardware (if applicable): - ---- - ### Acceptance Criteria > _What would make this feature complete? List specific requirements._ @@ -101,15 +78,6 @@ assignees: '' --- -### Related Code / Logs - -> _Paste code snippets or error messages (use ``` for code blocks)._ - -```rust -// Example code -``` ---- - ### Other Comments? (optional) > _Are there other statements or comments you would like to make about this feature?_ From cc954a51b5f98e63aaaf6c8ebe5e1f2bd3b5bf21 Mon Sep 17 00:00:00 2001 From: Haoran Fang <ifh_fang.h@outlook.com> Date: Sun, 27 Jul 2025 20:42:04 +1000 Subject: [PATCH 5/8] Update pr-fix-template.md - removed 'What was Changed' - removed 'Breaking Changes' - removed 'Related Issues/PRs' - changed 'Description' to 'Summary' - added 'Motivation' --- .github/ISSUE_TEMPLATE/pr-fix-template.md | 28 +++++++---------------- 1 file changed, 8 insertions(+), 20 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/pr-fix-template.md b/.github/ISSUE_TEMPLATE/pr-fix-template.md index 2022153..8e06f63 100644 --- a/.github/ISSUE_TEMPLATE/pr-fix-template.md +++ b/.github/ISSUE_TEMPLATE/pr-fix-template.md @@ -13,12 +13,18 @@ assignees: '' --- -### Description +### Summary > *Provide a short summary of what this PR changes, fixes, or adds.* --- +### Motivation + +> *Why are you making this pull request?* + +--- + ### Checklist Before Submission - [ ] My PR addresses a **SINGLE** concern or feature. @@ -38,27 +44,9 @@ assignees: '' --- -### What Was Changed - -> *Detailed explanation of the technical changes. Include performance impacts if relevant, and include a screenshot or image if necessary.* - ---- - -### Breaking Changes - -> *List any breaking changes. If none, write "None".* - ---- - ### Testing -> *Describe how you tested this PR (unit tests, real hardware, simulation, etc.). If tested on hardware, specify which V5 components were used.* - ---- - -### Related Issues / PRs - -> *Reference related issues or pull requests, e.g. `Fixes #123`, `Related to #456`.* +> *Describe how you tested/plan to test this PR (unit tests, real hardware, simulation, etc.). If tested on hardware, specify which V5 components were used.* --- From eaa76adf19dbab70ee08190baea05e5c6bb57cf9 Mon Sep 17 00:00:00 2001 From: LycoKodo <164467383+LycoKodo@users.noreply.github.com> Date: Mon, 28 Jul 2025 12:36:17 +1000 Subject: [PATCH 6/8] Delete .github/ISSUE_TEMPLATE/pr-fix-template.md --- .github/ISSUE_TEMPLATE/pr-fix-template.md | 55 ----------------------- 1 file changed, 55 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/pr-fix-template.md diff --git a/.github/ISSUE_TEMPLATE/pr-fix-template.md b/.github/ISSUE_TEMPLATE/pr-fix-template.md deleted file mode 100644 index 8e06f63..0000000 --- a/.github/ISSUE_TEMPLATE/pr-fix-template.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -name: PR/Fix Template -about: Create a pull request or suggest a fix for this project -title: "[PR/Fix]" -labels: pullrequest -assignees: '' - ---- - -### Pull Request - -> *Thank you for contributing to GravLib! Please complete the checklist and fill out the relevant sections.* - ---- - -### Summary - -> *Provide a short summary of what this PR changes, fixes, or adds.* - ---- - -### Motivation - -> *Why are you making this pull request?* - ---- - -### Checklist Before Submission - -- [ ] My PR addresses a **SINGLE** concern or feature. -- [ ] I **HAVE TESTED** the code and it compiles without warnings. -- [ ] I **HAVE NOT** broken existing public APIs. -- [ ] I **HAVE** documented new public APIs using Rustdoc comments. -- [ ] I **HAVE NOT** introduced compiler warnings. -- [ ] I **HAVE** checked that this PR passes existing unit tests. -- [ ] I **HAVE** added unit tests for any new functionality or bug fixes (if applicable). -- [ ] I **HAVE** not broken the continuous integration build. -- [ ] I **HAVE** avoided major architectural changes unless previously discussed. -- [ ] I **HAVE** adhered to GravLib naming conventions. -- [ ] I **HAVE** tested on actual V5 hardware (if applicable). -- [ ] I **HAVE** verified memory usage is within V5 constraints. -- [ ] I **HAVE** checked compatibility with target VEX V5 brain firmware version. -- [ ] I **HAVE** verified real-time performance is not negatively impacted. - ---- - -### Testing - -> *Describe how you tested/plan to test this PR (unit tests, real hardware, simulation, etc.). If tested on hardware, specify which V5 components were used.* - ---- - -### Additional Notes - -> *Add any additional information, such as future work, limitations, or things to review closely.* From 96a68d871f6e0eea7953b60983fb231b804a8044 Mon Sep 17 00:00:00 2001 From: LycoKodo <164467383+LycoKodo@users.noreply.github.com> Date: Mon, 28 Jul 2025 12:42:35 +1000 Subject: [PATCH 7/8] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 39 ++++++---------------------- 1 file changed, 8 insertions(+), 31 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 3e4b85d..43ad379 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,34 +1,19 @@ --- name: Bug report -about: Create a report to help us improve -title: "[BUG]" +about: Report something that went wrong! +title: "🐛[BUG] -" labels: bug assignees: '' --- ---- -name: `Title` -about: `Report a bug.` -title: `"[BUG] <title>"` -labels: `""` -assignees: `""` - ---- - -### Bug / Feature / Question +### Describe the bug. -> _Please complete the relevant sections. Incomplete issues may be closed._ +> _Clear and concise description of the bug. --- -### Description / Summary - -> _Clear and concise description of the issue, request, or question._ - ---- - -### Reproduction Steps +### To Reproduce > _Steps to trigger the bug. Provide the minimal setup._ @@ -38,13 +23,6 @@ assignees: `""` --- -### Expected vs Actual Behaviour - -- **Expected:** -- **Actual:** - ---- - ### Environment > _Provide environment details or leave `N/A`._ @@ -52,12 +30,10 @@ assignees: `""` - GravLib Version: - VEX Brain Firmware: - Rust Version: -- Target Platform (e.g., VEX V5, PROS, RMS, VEXCode): -- Operating System: --- -### Related Code / Logs +### Related Code / Logs > _Paste code snippets or error messages (use ``` for code blocks)._ @@ -66,6 +42,7 @@ assignees: `""` ``` --- -### Other Comments? (optional) +### Additional Comments (optional) > _Are there other statements or comments you would like to make about this bug, feature or question?_ + From 2508b5b54133be8615613b3f0884a926ce45dcb6 Mon Sep 17 00:00:00 2001 From: LycoKodo <164467383+LycoKodo@users.noreply.github.com> Date: Mon, 28 Jul 2025 12:45:37 +1000 Subject: [PATCH 8/8] Update feature-request.md --- .github/ISSUE_TEMPLATE/feature-request.md | 66 +++-------------------- 1 file changed, 6 insertions(+), 60 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index fed50d8..2555f6c 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -1,19 +1,13 @@ --- name: Feature request about: Suggest an idea for this project -title: "[FEAT.]" +title: "[FEATURE]" labels: enhancement assignees: '' --- -### Feature - -> _Please complete the relevant sections. Incomplete issues may be closed._ - ---- - -### Description / Summary +### Describe the Requested Feature > _Clear and concise description of the issue, request, or question._ @@ -21,63 +15,15 @@ assignees: '' ### Current Implementation -> _What implementation of your feature is already existing, or is your feature new (if this is the case, state `'No Current Implementation'`)_ - ---- - -### Problem/Use Case - -> _What problem does this feature solve? How would it be used in a VEX robotics context?_ +> _Is there any current implementations in the codebase that addresses this? --- -### Proposed Solutions - -> _Describe your ideal solution. Include code examples or API mockups if possible._ -> _For Example: ```// Example of how the feature might be used```_ - ---- - -### Alternatives Considered - -> _Describe any alternative solutions or workarounds you've considered. If none, write "None"._ - ---- - -### Competition Relevance - -> _Is this feature needed for competition use? Does it address common competition scenarios?_ - -- [ ] Critical for competition use -- [ ] Helpful for competition use -- [ ] General quality of life improvement -- [ ] Development/debugging tool - ---- - -### Implementation Impact - -> _Consider the impact on the library (check all that apply):_ - -- [ ] This is a breaking change -- [ ] This may impact performance -- [ ] This may impact memory usage -- [ ] This requires new dependencies -- [ ] This affects hardware compatibility - ---- - -### Acceptance Criteria - -> _What would make this feature complete? List specific requirements._ +### Motivation -- [ ] [FILL: Criterion 1] -- [ ] [FILL: Criterion 2] -- [ ] e.g. Documentation updated -- [ ] e.g. Unit tests added +> _Why do you think this is useful? --- -### Other Comments? (optional) +### Additional Comments (optional) -> _Are there other statements or comments you would like to make about this feature?_