From c086f7da5a440a3fff4ad4ec5edd39e2923f197a Mon Sep 17 00:00:00 2001 From: Ryo Kato <179401529+theryokato@users.noreply.github.com> Date: Mon, 5 Oct 2026 15:02:19 -0500 Subject: [PATCH 1/2] docs(github): add issue forms and pull request template Add bug, feature, content, and task issue forms. Disable blank issues. Add a security contact link. Add a pull request template with a tests checklist that matches the package scripts and the CI check. --- .github/ISSUE_TEMPLATE/01-bug.yml | 51 +++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/02-feature.yml | 43 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/03-content.yml | 45 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/04-task.yml | 34 ++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++ .github/pull_request_template.md | 35 ++++++++++++++++++ 6 files changed, 213 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/01-bug.yml create mode 100644 .github/ISSUE_TEMPLATE/02-feature.yml create mode 100644 .github/ISSUE_TEMPLATE/03-content.yml create mode 100644 .github/ISSUE_TEMPLATE/04-task.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/01-bug.yml b/.github/ISSUE_TEMPLATE/01-bug.yml new file mode 100644 index 00000000..0e5312ba --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-bug.yml @@ -0,0 +1,51 @@ +name: Bug report +description: Report a problem with the website +labels: + - bug +body: + - type: textarea + id: problem + attributes: + label: Problem + description: Describe the problem. Write what happens and what you see. + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: Write the steps that show the problem. Start each step on a new line. + placeholder: | + 1. Go to '...' + 2. Click '...' + 3. See the error + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected result + description: Describe what you expected to see. + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots or recordings + description: Add images or videos that show the problem. This field is optional. + validations: + required: false + - type: input + id: browser-device + attributes: + label: Browser and device + description: Write your browser, operating system, and device. For example, Chrome 130, macOS 15, MacBook Pro. + validations: + required: false + - type: textarea + id: additional + attributes: + label: Additional information + description: Add other information about the problem. This field is optional. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/02-feature.yml b/.github/ISSUE_TEMPLATE/02-feature.yml new file mode 100644 index 00000000..3a7be3c2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-feature.yml @@ -0,0 +1,43 @@ +name: Feature request +description: Request a new feature or an improvement +labels: + - enhancement +body: + - type: textarea + id: change + attributes: + label: Requested change + description: Describe the change that you want. + validations: + required: true + - type: textarea + id: reason + attributes: + label: Reason + description: Explain why the website needs this change. + validations: + required: true + - type: textarea + id: requirements + attributes: + label: Requirements + description: List what the change must do. Write each item on a new line. Use a checkbox for each item. + placeholder: | + - [ ] Requirement 1 + - [ ] Requirement 2 + validations: + required: true + - type: textarea + id: design + attributes: + label: Design or implementation information + description: Add design notes, examples, or implementation ideas. This field is optional. + validations: + required: false + - type: textarea + id: additional + attributes: + label: Additional information + description: Add other information about the request. This field is optional. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/03-content.yml b/.github/ISSUE_TEMPLATE/03-content.yml new file mode 100644 index 00000000..e627fa3a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-content.yml @@ -0,0 +1,45 @@ +name: Content change +description: Request a change to website content +labels: + - content +body: + - type: dropdown + id: change-type + attributes: + label: Change type + description: Select the type of change. + options: + - Add content + - Update content + - Remove content + - Correct content + validations: + required: true + - type: input + id: page + attributes: + label: Page or section + description: Write the page or section that the change affects. For example, Home page, Hero section. + validations: + required: true + - type: textarea + id: change + attributes: + label: Requested change + description: Describe the content change that you want. + validations: + required: true + - type: textarea + id: source + attributes: + label: Source information + description: Add sources or references for the content. This field is optional. + validations: + required: false + - type: textarea + id: additional + attributes: + label: Additional information + description: Add other information about the request. This field is optional. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/04-task.yml b/.github/ISSUE_TEMPLATE/04-task.yml new file mode 100644 index 00000000..51877af1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04-task.yml @@ -0,0 +1,34 @@ +name: Development task +description: Track maintenance or development work +body: + - type: textarea + id: task + attributes: + label: Task + description: Describe the task. Write the goal and the scope. + validations: + required: true + - type: textarea + id: reason + attributes: + label: Reason + description: Explain why the project needs this task. + validations: + required: true + - type: textarea + id: work-items + attributes: + label: Work items + description: List the work items. Write each item on a new line. Use a checkbox for each item. This field is optional. + placeholder: | + - [ ] Work item 1 + - [ ] Work item 2 + validations: + required: false + - type: textarea + id: additional + attributes: + label: Additional information + description: Add other information about the task. This field is optional. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..aacbba4e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Security + url: https://github.com/turtle-robotics/Turtle-website/security + about: Do not report security vulnerabilities in a public issue. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..025bc0f6 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,35 @@ +## Summary + +Describe what this pull request changes. Explain why the change is necessary. + +## Related issue + +Closes # + +If this pull request resolves an issue, write `Closes #123` with the issue number. + +## Changes + +List the main changes. Write each change on a new line. + +## Screenshots + +Visible website changes require screenshots. Delete this section if it does not apply. + +| Before | After | +| --- | --- | +| | | + +## Tests + +- [ ] I tested the changes locally. +- [ ] `npm run lint` passes. +- [ ] `npm run build` passes. +- [ ] `npx prettier ./src/ --check` passes. + +## Checklist + +- [ ] This pull request contains only related changes. +- [ ] I reviewed my changes. +- [ ] I updated the documentation or website content where the change requires it. +- [ ] I tested the layout on different screen sizes if this change affects the user interface. \ No newline at end of file From 7b4ad090d4c4fa11c45d97d10f3e07f18195933f Mon Sep 17 00:00:00 2001 From: Ryo Kato <179401529+theryokato@users.noreply.github.com> Date: Tue, 6 Oct 2026 22:15:49 -0500 Subject: [PATCH 2/2] fix: fixed wrong test commands in PR template --- .github/pull_request_template.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 025bc0f6..dd22ee36 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,8 +6,6 @@ Describe what this pull request changes. Explain why the change is necessary. Closes # -If this pull request resolves an issue, write `Closes #123` with the issue number. - ## Changes List the main changes. Write each change on a new line. @@ -20,16 +18,17 @@ Visible website changes require screenshots. Delete this section if it does not | --- | --- | | | | +## AI-assisted Code + ## Tests - [ ] I tested the changes locally. -- [ ] `npm run lint` passes. - [ ] `npm run build` passes. -- [ ] `npx prettier ./src/ --check` passes. +- [ ] `npm run format` passes. ## Checklist - [ ] This pull request contains only related changes. - [ ] I reviewed my changes. - [ ] I updated the documentation or website content where the change requires it. -- [ ] I tested the layout on different screen sizes if this change affects the user interface. \ No newline at end of file +- [ ] I tested the layout on different screen sizes if this change affects the user interface.