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

docs: create issue templates #282

Merged
merged 8 commits into from
Sep 19, 2019
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
15 changes: 0 additions & 15 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/--bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: "🐛 Bug report"
about: Report a problem with Spectrum CSS
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe just "report a bug"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It renders like this, so I think Bug report with the description works well here:

image

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah cool to see the context! this might make it more consistent.

title: ''
labels: bug
assignees: ''

---

## Description
<!-- Describe the problem you're having and paste any error messages you received -->


## Steps to reproduce

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe something like URL?
Those will be very useful.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. That's what I meant with Go to '...', I will make that more clear

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you could pre-fill a URL in markdown there [URL](https://adobe.com) and make it even easier.

1. Go to http://opensource.corp.adobe.com/spectrum-css/
2. Click on ...
3. Observe ...


## Expected behavior
<!-- Describe what you expected to happen -->


## Screenshots
<!-- If applicable, add screenshots to help explain the problem -->


## Environment
- Spectrum CSS version: <!-- 2.13.0 -->
- Browser(s) and OS(s): <!-- Chrome 75.0.3770.142 on Win 10 -->

## Additional context
<!-- Provide any additional information that might help us debug the issue -->

20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/--documentation-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: "📚 Documentation issue"
about: Report an issue with the project documentation
title: ''
labels: documentation
assignees: ''

---

## Description
<!-- Describe what's missing, unclear, or incorrect -->


## Link to documentation
<!-- Paste the link to the document where the issue exists -->


## Additional context
<!-- Provide any additional information that might help us understand the issue -->

20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/--feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: "✨ Feature request"
about: Suggest a new feature or component
title: ''
labels: enhancement
assignees: ''

---

## Description
<!-- Describe your suggested feature in detail -->


## Why do you need this feature or component?
<!-- Tell us what this solves or why this is important to your use case -->


## Additional context
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe ## Additional context and screenshots

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the line below covers screenshots, I'll make it a comment like the other files.

<!-- Add any other context, workarounds, or screenshots about your request -->

24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/--support-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: "📚 Support request"
about: Ask for help with using Spectrum CSS
title: ''
labels: question
assignees: ''

---

## Description
<!-- Describe the problem you're having and paste any error messages you received -->


## Screenshots
<!-- If applicable, add screenshots to show what you need help with -->


## Environment
- Spectrum CSS version: <!-- 2.13.0 -->
- Browser and OS: <!-- Chrome 75.0.3770.142 on Win 10 -->

## Additional context
<!-- Provide any additional information that might help us understand your request -->