diff --git a/.github/ISSUE_TEMPLATE/01-bug-report.md b/.github/ISSUE_TEMPLATE/01-bug-report.md index dc2e58b..99ff939 100644 --- a/.github/ISSUE_TEMPLATE/01-bug-report.md +++ b/.github/ISSUE_TEMPLATE/01-bug-report.md @@ -1,7 +1,7 @@ --- -name: Bug report -about: Create a report to help us improve -title: "[Bug]" +name: Bug +about: Submit a bug describing a problematic behavior +title: "[Bug title]" labels: bug assignees: '' @@ -11,6 +11,10 @@ assignees: '' A description of the bug and how you found it, including steps to reproduce and notable parameters such as browser and OS. Also include how the system should have behaved. Provide screenshots if applicable. +## Steps to Reproduce + +Describe the steps to reproduce the issue. + ## Acceptance Criteria - Bulleted list of what would constitute this bug being resolved diff --git a/.github/ISSUE_TEMPLATE/02-feature-request.md b/.github/ISSUE_TEMPLATE/02-feature-request.md index 179deb7..6566ede 100644 --- a/.github/ISSUE_TEMPLATE/02-feature-request.md +++ b/.github/ISSUE_TEMPLATE/02-feature-request.md @@ -1,7 +1,7 @@ --- name: Feature request -about: Feature Request or Enhancement -title: "[Feature or enhancement request]" +about: Submit a new feature idea or enhancement request +title: "[Feature or enhancement request title]" labels: enhancement assignees: '' diff --git a/.github/ISSUE_TEMPLATE/03-usage-submission.md b/.github/ISSUE_TEMPLATE/03-usage-submission.md new file mode 100644 index 0000000..efe3fb6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-usage-submission.md @@ -0,0 +1,20 @@ +--- +name: Usage submission +about: Submit a site using this project as an example of usage +title: "[Site name]" +labels: usage +assignees: '' + +--- + +## Site + +Provide the URL for your site. + +## Usage Examples + +Provide a list of any URLs for pages within your site that demonstrate usage of the project. + +## Comments + +Add any other comments or thoughts about your usage of the project. diff --git a/README.md b/README.md index c3ce67e..4057b6d 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,8 @@ Please see the following pages for more information: ### Site Builder Examples -If you're a site builder using Guitar Diagrams JS, your site should be featured here as an example of how to use this library. Please [submit an Issue](https://github.com/KCarlile/guitar-diagrams-js/issues/new/choose) with a link to your site, plus any links to specific pages using Guitar Diagrams JS, and it will be added to the list below. +If you're a site builder using Guitar Diagrams JS, your site should be featured here as an example of how to use this library. +Please [submit an issue of Usage Submission type](https://github.com/KCarlile/guitar-diagrams-js/issues/new?labels=usage&template=03-usage-submission.md&title=%5BSite%20name%5D) with a link to your site, plus any links to specific pages using Guitar Diagrams JS, and it will be added to the list below. **Example sites:** diff --git a/docs/code-owner-docs.md b/docs/code-owner-docs.md index 5659884..8fc73d2 100644 --- a/docs/code-owner-docs.md +++ b/docs/code-owner-docs.md @@ -32,6 +32,7 @@ This section outlines the directory structure of the project. - `ISSUE_TEMPLATE/`: Markdown files for GitHub issue templates. - `01-bug-report.md`: Template for GitHub issues of type bug. - `02-feature-request.md`: Template for GitHub issues of type feature request. + - `03-usage-submission.md`: Template for GitHub issues of type usage submission. - `config.yml`: GitHub Actions config. - `workflows/`: YML files to define GitHub Actions. - `demo-hosting.yml`: GitHub Actions workflow to deploy `examples/` content to GoDaddy hosting for demos.