From a8fb3f6c5c56f2cedf08dc5d1297a842ccc7e7ab Mon Sep 17 00:00:00 2001 From: teknium1 Date: Tue, 6 May 2025 18:14:33 -0700 Subject: [PATCH] Fix PR Template for GitHub Web --- .../non_environment_pull_request_template.md | 30 ----------- ...t_template.md => pull_request_template.md} | 53 +++++++++++++++---- 2 files changed, 42 insertions(+), 41 deletions(-) delete mode 100644 .github/non_environment_pull_request_template.md rename .github/{environment_pull_request_template.md => pull_request_template.md} (51%) diff --git a/.github/non_environment_pull_request_template.md b/.github/non_environment_pull_request_template.md deleted file mode 100644 index b6b2bfae..00000000 --- a/.github/non_environment_pull_request_template.md +++ /dev/null @@ -1,30 +0,0 @@ -## Description - - - -## Related Issues - - - -## Type of Change - - - -- [ ] Bug fix (non-breaking change which fixes an issue) -- [ ] New feature (non-breaking change which adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) -- [ ] This change requires a documentation update -- [ ] Code refactor (no functional changes) -- [ ] Build/CI/CD related changes -- [ ] Other (please describe): - -## Checklist - -- [ ] My code follows the style guidelines of this project -- [ ] I have performed a self-review of my own code -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation -- [ ] My changes generate no new warnings -- [ ] I have added tests that prove my fix is effective or that my feature works -- [ ] New and existing unit tests pass locally with my changes -- [ ] Any dependent changes have been merged and published in downstream modules diff --git a/.github/environment_pull_request_template.md b/.github/pull_request_template.md similarity index 51% rename from .github/environment_pull_request_template.md rename to .github/pull_request_template.md index 4e9a30db..099cfe2d 100644 --- a/.github/environment_pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,12 +1,40 @@ +## PR Type + +- [ ] RL Environment PR - Complete Environment Snapshot & Zero-Training sections +- [ ] Non-Environment PR - Complete Description, Related Issues & Type of Change sections + +--- + +## 📝 General Information + +### Description + + +### Related Issues + + +### Type of Change + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update +- [ ] Code refactor (no functional changes) +- [ ] Build/CI/CD related changes +- [ ] Other (please describe): + +--- + ## 🔖 Environment Snapshot + | Field | Your Entry | |-------|------------| | **Environment Name** | | @@ -18,9 +46,8 @@ | **Expected Episode Length** | | | **Compute Footprint Estimate** | | ---- - ## 🧪 Zero-Training Test Results +
**W&B Link:** @@ -29,16 +56,20 @@
+--- ## ✅ Developer & Reviewer Checklist -- [ ] Code follows project style (black, isort, flake8 pass with pre-commit). + +- [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code -- [ ] Docstrings added for all new public classes / functions. -- [ ] If .env vars required, did you add it to the .env.example in repo root? -- [ ] Automatic rollout script (`scripts/run_smoke_test.py`) runs without training and reproduces the metrics above. - [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation to include my environment +- [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] New and existing unit tests pass locally with my changes ---- + +- [ ] Code follows project style (black, isort, flake8 pass with pre-commit) +- [ ] Docstrings added for all new public classes / functions +- [ ] If .env vars required, did you add it to the .env.example in repo root? +- [ ] Automatic rollout script (`scripts/run_smoke_test.py`) runs without training and reproduces the metrics above +- [ ] I have made corresponding changes to the documentation to include my environment \ No newline at end of file