diff --git a/.github/ISSUE_TEMPLATE/01-report-issue.yml b/.github/ISSUE_TEMPLATE/01-report-issue.yml new file mode 100644 index 000000000..5f2bf8fee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-report-issue.yml @@ -0,0 +1,83 @@ +name: Report a Bug +description: Report broken functionality or other website behavior that is not working as expected. +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for helping improve Section508.gov. Please search [existing issues](https://github.com/GSA/Section508.gov/issues) before submitting to avoid duplicates. + + - type: input + id: page-url + attributes: + label: Page URL + description: The full URL of the page where you found the issue. + placeholder: https://www.section508.gov/... + validations: + required: true + + - type: textarea + id: description + attributes: + label: Description of the issue + description: What's wrong? + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: What did you expect to happen? + validations: + required: false + + - type: textarea + id: actual-behavior + attributes: + label: Actual behavior + description: What actually happened? + validations: + required: false + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to reproduce + description: If applicable, list the steps to see the issue. + placeholder: | + 1. Go to... + 2. Click on... + 3. See error + validations: + required: false + + - type: input + id: browser-os + attributes: + label: Browser and operating system + placeholder: ex. Chrome 128 on macOS 14 + validations: + required: false + + - type: dropdown + id: issue-type + attributes: + label: Issue type + description: What kind of issue is this? + options: + - Broken functionality + - Incorrect information + - Other + validations: + required: true + + - type: textarea + id: additional-context + attributes: + label: Screenshots or supporting files + description: | + If applicable, add screenshots or files to help explain the issue. You can attach files by dragging them into this field. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/02-suggest-change.yml b/.github/ISSUE_TEMPLATE/02-suggest-change.yml new file mode 100644 index 000000000..29783c226 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-suggest-change.yml @@ -0,0 +1,56 @@ +name: Suggest a Change +description: Recommend an improvement to website content, navigation, features, or functionality. +title: "[Enhancement]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for helping improve Section508.gov. Please search [existing issues](https://github.com/GSA/Section508.gov/issues) before submitting to avoid duplicates. + + - type: input + id: page-url + attributes: + label: Page URL + description: The full URL of the relevant page, if applicable. + placeholder: https://www.section508.gov/... + validations: + required: false + + - type: textarea + id: current-problem + attributes: + label: Description of the current problem + validations: + required: true + + - type: textarea + id: proposed-solution + attributes: + label: Proposed solution + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives considered + validations: + required: false + + - type: textarea + id: expected-benefit + attributes: + label: Expected benefit + description: Who does this help, and how? + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Supporting information, screenshots, or files + description: | + Add any other context, screenshots, or files. You can attach files by dragging them into this field. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/03-content-issue.yml b/.github/ISSUE_TEMPLATE/03-content-issue.yml new file mode 100644 index 000000000..b1070b42f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-content-issue.yml @@ -0,0 +1,42 @@ +name: Report a Content Issue +description: Report inaccurate, unclear, outdated, or missing website content. +title: "[Content]: " +labels: ["content"] +body: + - type: markdown + attributes: + value: | + Thanks for helping improve Section508.gov. Please search [existing issues](https://github.com/GSA/Section508.gov/issues) before submitting to avoid duplicates. + + - type: input + id: page-url + attributes: + label: Page URL + description: The full URL of the page with the content issue. + placeholder: https://www.section508.gov/... + validations: + required: true + + - type: textarea + id: description + attributes: + label: Description of the content issue + description: What content is inaccurate, unclear, outdated, or missing? + validations: + required: true + + - type: textarea + id: suggested-change + attributes: + label: Suggested change + description: Describe the correction or content that should be added, if known. + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Supporting information, screenshots, or files + description: Add any context that will help us review the issue. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/04-accessibility-issue.yml b/.github/ISSUE_TEMPLATE/04-accessibility-issue.yml new file mode 100644 index 000000000..f6eae8d5e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04-accessibility-issue.yml @@ -0,0 +1,50 @@ +name: Report an Accessibility Issue +description: Report an accessibility barrier or difficulty using Section508.gov. +title: "[Accessibility]: " +labels: ["accessibility"] +body: + - type: markdown + attributes: + value: | + Thanks for helping improve Section508.gov. Please search [existing issues](https://github.com/GSA/Section508.gov/issues) before submitting to avoid duplicates. + + - type: input + id: page-url + attributes: + label: Page URL + description: The full URL of the page where you experienced the accessibility issue. + placeholder: https://www.section508.gov/... + validations: + required: true + + - type: textarea + id: description + attributes: + label: Description of the accessibility issue + description: What barrier did you encounter? + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to reproduce + description: List the steps needed to encounter the issue. + validations: + required: false + + - type: input + id: assistive-technology + attributes: + label: Browser, operating system, and assistive technology + placeholder: ex. Chrome 128 on macOS 14 with VoiceOver + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Screenshots or supporting files + description: Add any context, screenshots, or files that help explain the barrier. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/05-feedback.yml b/.github/ISSUE_TEMPLATE/05-feedback.yml new file mode 100644 index 000000000..abfba94fe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/05-feedback.yml @@ -0,0 +1,34 @@ +name: Share Feedback +description: Share feedback about the Section508.gov website or your experience using it. +title: "[Feedback]: " +labels: ["feedback"] +body: + - type: markdown + attributes: + value: | + Thanks for helping improve Section508.gov. Please search [existing issues](https://github.com/GSA/Section508.gov/issues) before submitting to avoid duplicates. + + - type: input + id: page-url + attributes: + label: Page URL + description: The full URL of the relevant page, if applicable. + placeholder: https://www.section508.gov/... + validations: + required: false + + - type: textarea + id: feedback + attributes: + label: Feedback + description: Tell us what worked well or what could be improved. + validations: + required: true + + - type: textarea + id: additional-context + attributes: + label: Supporting information, screenshots, or files + description: Add any other context that may help us understand your feedback. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..b5635cc65 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: General Support + url: https://www.section508.gov/contact-us/ + about: Email the Section508.gov team for general support questions. + - name: Contact Section508.gov + url: https://www.section508.gov/contact-us/ + about: Use our contact form for other inquiries. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cdefc03d3..dbd25f660 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,6 +15,21 @@ Please keep interactions respectful, constructive, and focused on improving the - For small fixes, such as typos, broken links, metadata corrections, and focused bug fixes, opening a pull request directly is usually fine. - Do not include sensitive information, non-public government information, credentials, analytics secrets, or private user data. +## Issue Forms + +Issue forms are stored in `.github/ISSUE_TEMPLATE/`: + +- `01-report-issue.yml` reports bugs and applies the `bug` label. +- `02-suggest-change.yml` captures proposed improvements and applies the `enhancement` label. +- `03-content-issue.yml` reports inaccurate, unclear, outdated, or missing content and applies `content`. +- `04-accessibility-issue.yml` reports accessibility barriers and applies `accessibility`. +- `05-feedback.yml` collects general website feedback and applies `feedback`. +- `config.yml` disables blank issues and provides links for general support and contact requests. + +Labels are fixed per form because GitHub does not dynamically apply labels from dropdown selections. The five labels must exist in the repository for automatic labeling to work. Forms are rendered from the default branch at `https://github.com/GSA/Section508.gov/issues/new/choose`. + +Maintainers should review new labels for consistent naming and descriptions, confirm the labels exist in repository settings, and update this section whenever forms, labels, contact links, or routing procedures change. + ## Content Contributions Most website content lives in `_pages/`, `_posts/`, `_events/`, `_contributors/`, and `_data/`.