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..dd22ee36 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,34 @@ +## Summary + +Describe what this pull request changes. Explain why the change is necessary. + +## Related issue + +Closes # + +## 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 | +| --- | --- | +| | | + +## AI-assisted Code + +## Tests + +- [ ] I tested the changes locally. +- [ ] `npm run build` 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.