Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Additional changes from issue 53 into 10-productize-documentation #57

Merged
merged 3 commits into from
Jun 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions .github/ISSUE_TEMPLATE/01-bug-report.md
Original file line number Diff line number Diff line change
@@ -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: ''

Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/02-feature-request.md
Original file line number Diff line number Diff line change
@@ -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: ''

Expand Down
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/03-usage-submission.md
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:**

Expand Down
1 change: 1 addition & 0 deletions docs/code-owner-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down