From 77ca99a93c0884923302cbe849b2cbfe56b92af1 Mon Sep 17 00:00:00 2001 From: Shahab Date: Thu, 10 Apr 2025 22:02:57 -0400 Subject: [PATCH 1/2] Update templates and remove label workflow --- .github/ISSUE_TEMPLATE/chapter_template.md | 27 ++++++++++++++-- .github/PULL_REQUEST_TEMPLATE.md | 36 ++++++++++++++++++---- .github/workflows/label_issues.yml | 18 ----------- 3 files changed, 54 insertions(+), 27 deletions(-) delete mode 100644 .github/workflows/label_issues.yml diff --git a/.github/ISSUE_TEMPLATE/chapter_template.md b/.github/ISSUE_TEMPLATE/chapter_template.md index e71cb99..2e2aeee 100644 --- a/.github/ISSUE_TEMPLATE/chapter_template.md +++ b/.github/ISSUE_TEMPLATE/chapter_template.md @@ -1,5 +1,26 @@ -# Chapter +# Chapter Reading Issue -## Key Concepts +## Chapter Details -Link to Chapter: +- **Chapter Number:** [Insert chapter number] +- **Chapter Title:** [Insert chapter title] +- **Date Read:** [Insert date] + +## Summary +> +> [Provide a brief summary of the chapter content.] + +## Key Takeaways + +- [Key takeaway 1] +- [Key takeaway 2] +- [Key takeaway 3] + +## Open Questions / Clarifications + +- [Question or comment 1] +- [Question or comment 2] + +## Additional Notes +> +> [Any extra thoughts or discussion points] diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0ff2a64..483bab5 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,8 +1,32 @@ - +# Pull Request Title -# Description - +## Description -## Motivation and Context - - +- **What:** Brief summary of changes. +- **Why:** Purpose and impact of these changes. + +## Related Issue(s) + +- Link to any related issue(s) or mention "N/A". + +## Proposed Changes + +- **Change 1:** Explain briefly. +- **Change 2:** Explain briefly. +- ... + +## How to Test + +1. Step-by-step instructions to verify changes. +2. Mention any specific configurations if needed. + +## Checklist + +- [ ] Code compiles without errors. +- [ ] Relevant documentation updated. +- [ ] Tests written/updated and passing. +- [ ] Manual testing performed. + +## Additional Notes + +- Any extra details, screenshots, or context. diff --git a/.github/workflows/label_issues.yml b/.github/workflows/label_issues.yml deleted file mode 100644 index 8e94091..0000000 --- a/.github/workflows/label_issues.yml +++ /dev/null @@ -1,18 +0,0 @@ -name: Label issues -on: - issues: - types: - - reopened - - opened -jobs: - label_issues: - runs-on: ubuntu-latest - permissions: - issues: write - steps: - - run: gh issue edit "$NUMBER" --add-label "$LABELS" - env: - GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} - GH_REPO: ${{ github.repository }} - NUMBER: ${{ github.event.issue.number }} - LABELS: todo From 0d1b25d4ba8ba5300792e04e5d86349febe78e43 Mon Sep 17 00:00:00 2001 From: Shahab Date: Thu, 10 Apr 2025 22:10:58 -0400 Subject: [PATCH 2/2] modify template --- .github/PULL_REQUEST_TEMPLATE.md | 22 ++++++---------------- 1 file changed, 6 insertions(+), 16 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 483bab5..741f119 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,24 +1,15 @@ -# Pull Request Title - -## Description - +# Description + ## Related Issue(s) - -- Link to any related issue(s) or mention "N/A". + ## Proposed Changes -- **Change 1:** Explain briefly. -- **Change 2:** Explain briefly. -- ... - -## How to Test - -1. Step-by-step instructions to verify changes. -2. Mention any specific configurations if needed. +- ## Checklist @@ -28,5 +19,4 @@ - [ ] Manual testing performed. ## Additional Notes - -- Any extra details, screenshots, or context. +