Skip to content

Commit

Permalink
(no ticket): [repo] Issue templates, new (#3)
Browse files Browse the repository at this point in the history
<!-- Ticket number or summary of work -->
# No ticket: issue templates

## What changed?
<!-- Provide a bulleted list in the present tense -->
* add issue template config and bug report template

## Release notes draft
<!-- Provide an entry for the release notes using simple, conversational
language. Don't be too technical. Explain how the change will benefit
the merchant and link to the feature.

Examples:
* The newly-released [X feature] is now available to use. Now, you’ll be
able to [perform Y action].
* We're happy to announce [X feature], which can help you [perform Y
action].
* [X feature] helps you to create [Y response] using the [Z query
parameter]. Now, you can deliver [ex, localized shopping experiences for
your customers].
* Fixed a bug in the [X endpoint]. Now the [Y field] will appear when
you click [Z option]. -->

## Anything else?
<!-- Add related PRs, salient notes, additional ticket numbers, etc. -->

ping {names}
  • Loading branch information
slsriehl committed Jun 14, 2024
1 parent efd0d11 commit c19ed0d
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATES/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: 🖍️ Incorrect documentation report
description: Something is wrong or missing from the docs.
labels:
- 'bug:unverified'
body:
- type: markdown
attributes:
value: |
Thank you for helping improve the BigCommerce DevDocs!
## Tell us what's missing!
- type: input
attributes:
label: What is the link to the page that needs updating? Provide multiple links if needed.
validations:
required: true
- type: textarea
attributes:
label: What needs to be documented?
description: A concise description of what you expect to see here.
validations:
required: true
- type: textarea
attributes:
label: What is currently documented?
description: A concise description of what you're actually seeing.
validations:
required: true
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATES/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
blank_issues_enabled: false
contact_links:
- name: Get BigCommerce help
url: https://support.bigcommerce.com/s/contact
about:
If you need to file a BigCommerce bug report or platform outage, contact our Support team. Contact information is in the store control panel. Partners, please use your Partner Portal to open a case.
- name: Docs + DevCenter feature request
url: https://github.com/bigcommerce/docs/discussions/new?category=ideas-feature-requests
about:
We appreciate you taking the time to improve our docs! Meet us in Discussions to talk further about your feature request.
- name: 💬 BigCommerce community
url: https://developer.bigcommerce.com/community
about: Meet and chat with other people building with BigCommerce.

0 comments on commit c19ed0d

Please sign in to comment.