From fcc8770db3e28f2174d46b80cef6fc19368e8ba2 Mon Sep 17 00:00:00 2001 From: geoffreygarrett <26066340+geoffreygarrett@users.noreply.github.com> Date: Sat, 11 Jan 2025 14:07:01 +0200 Subject: [PATCH 1/2] Add templates and CODEOWNERS to streamline repository workflow --- .github/CODEOWNERS | 4 ++++ .github/ISSUE_TEMPLATE/bug_report.md | 22 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 16 ++++++++++++++++ .github/pull_request_template.md | 13 +++++++++++++ 4 files changed, 55 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/pull_request_template.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..fc0f5de --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,4 @@ +# CODEOWNERS assigns reviewers to pull requests based on file paths - in this example, +# you can specify multiple owners for a path using: path/ @user1 @user2 +# e.g. any changes to .github/ directory will request review from @geoffreygarrett +.github/ @geoffreygarrett \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..fc4af01 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,22 @@ +--- +name: Bug Report +about: Report a bug in the project +title: "" +labels: bug +assignees: "" +--- + +**Describe the bug** +A clear and concise description. + +**To Reproduce** +Steps to reproduce: +1. +2. +3. + +**Expected behavior** +What you expected to happen. + +**Additional context** +Logs, screenshots, or other info. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..dc9ce34 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,16 @@ +--- +name: Feature Request +about: Suggest an idea +title: "" +labels: enhancement +assignees: "" +--- + +**Is your feature request related to a problem?** +Short description. + +**Describe the solution you’d like** +Describe your solution. + +**Additional context** +Any other relevant info. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..2acdcd9 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,13 @@ +**Summary** +Brief overview of the changes. + +**Related Issues** +Links (e.g. closes #123). + +**Proposed Changes** +- +- + +**Checklist** +- [ ] Tests pass locally +- [ ] Documentation updated if needed From 74f83aff37855558e05870428d6839d9fb54fd4a Mon Sep 17 00:00:00 2001 From: geoffreygarrett <26066340+geoffreygarrett@users.noreply.github.com> Date: Sat, 11 Jan 2025 14:15:27 +0200 Subject: [PATCH 2/2] Add templates and CODEOWNERS to streamline repository workflow --- .github/CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index fc0f5de..c76e80b 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,4 +1,4 @@ # CODEOWNERS assigns reviewers to pull requests based on file paths - in this example, # you can specify multiple owners for a path using: path/ @user1 @user2 # e.g. any changes to .github/ directory will request review from @geoffreygarrett -.github/ @geoffreygarrett \ No newline at end of file +# .github/ @geoffreygarrett # No write access yet, so this errors in GH \ No newline at end of file