Skip to content

Commit

Permalink
chore: update issue and PR templates (#3896)
Browse files Browse the repository at this point in the history
* chore: update issue and PR templates

* chore: add missing issue metadata

* chore: formatting in issue templates and additional question for bugs

* chore: move the repo section in the bug template closer to the top

* chore: remove title guidelines from PR template

* chore: some formatting in issue templates

Co-authored-by: Jane Chu <[email protected]>
Co-authored-by: Aaron Wentzel <[email protected]>
Co-authored-by: Chris Holt <[email protected]>
  • Loading branch information
4 people authored Apr 5, 2021
1 parent a4fd105 commit 19c550d
Show file tree
Hide file tree
Showing 7 changed files with 176 additions and 96 deletions.
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
name: '🐛 Bug Report'
about: Did FAST not work as expected?
title: "fix: [what is the issue?] in [where is the issue?]"
labels: 'status:triage'
---

<!---
Thanks for filing an issue 😄 ! Before you submit, please read the following:
Search open/closed issues before submitting. Someone may have reported the same issue before.
-->

# 🐛 Bug Report

<!--- Provide a general summary of the issue here -->

## 💻 Repro or Code Sample

<!-- Please provide steps to reproduce the issue and/or a code repository, gist, code snippet or sample files -->

## 🤔 Expected Behavior

<!--- Tell us what should happen -->

## 😯 Current Behavior

<!--- Tell us what happens instead of the expected behavior -->
<!--- If you are seeing an error, please include the full error message and stack trace -->
<!--- If applicable, provide screenshots -->

## 💁 Possible Solution

<!--- Not obligatory, but suggest a fix/reason for the bug -->
<!--- Please let us know if you'd be willing to contribute the fix; we'd be happy to work with you -->

## 🔦 Context

<!--- How has this issue affected you? What are you trying to accomplish? -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->

## 🌍 Your Environment

<!--- Include as many relevant details as possible about the environment you experienced the bug in -->

* OS & Device: [e.g. MacOS, iOS, Windows, Linux] on [iPhone 7, PC]
* Browser [e.g. Microsoft Edge, Google Chrome, Apple Safari, Mozilla FireFox]
* Version [e.g. 1.8.0]
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: 📚 Documentation
about: Find an inaccuracy in the documentation or something missing?
title: "docs: fix/add [what] to/in [where]"
labels: 'status:triage'
---

<!---
Thanks for filing an issue 😄 ! Before you submit, please read the following:
Search open/closed issues before submitting. Someone may have reported the same issue before.
-->

# 🙋 Documentation Request

<!--- Provide a general summary of what is missing or incorrect in the documentation -->

## 💁 Possible Solution

<!--- Not obligatory, but feel free to suggest a content outline for larger topics -->
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: 🙋 Feature Request
about: Want us to add something to FAST?
title: "feat: add [what] to/in [where]"
labels: 'status:triage'
---

<!---
Thanks for filing an issue 😄 ! Before you submit, please read the following:
Search open/closed issues before submitting. Someone may have requested the same feature before.
-->

# 🙋 Feature Request

<!--- Provide a general summary of the feature here -->

## 🤔 Expected Behavior

<!--- Tell us how the feature should work -->

## 😯 Current Behavior

<!--- Explain how the feature would alter/enhance current behavior -->

## 💁 Possible Solution

<!--- Ideas how to implement this feature -->
<!--- What implementation solution would be ideal for you? -->

## 🔦 Context

<!--- What are you trying to accomplish? -->
<!--- How has not having this feature affected you? -->
<!--- What alternatives have you considered? -->

## 💻 Examples

<!-- Examples help us understand the requested feature better -->
<!-- Attach screenshots or images if they would add detail to your request -->
31 changes: 0 additions & 31 deletions .github/ISSUE_TEMPLATE/report-a-bug.md

This file was deleted.

20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/request-a-feature.md

This file was deleted.

27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/rfc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: 💬 Request For Comment (RFC)
about: Want comments from the team and community on your proposal?
title: "rfc: add [what] to/in [where]"
labels: 'status:triage'
---

<!---
Thanks for filing an issue 😄 ! Before you submit, please read the following:
Search open/closed issues before submitting. Someone may have created a similar RFC before.
-->

# 💬 RFC

<!--- Provide a detailed summary of the feature here -->

## 🔦 Context

<!--- What are you trying to accomplish? How has not having this feature affected you? -->
<!--- What alternatives have you considered? What are you trying to accomplish? -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->

## 💻 Examples

<!-- Examples help us understand the requested feature better -->
<!-- Attach screenshots or images if they would add detail to your request -->
86 changes: 41 additions & 45 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,66 @@
<!--- Provide a summary of your changes in the title field above. For guidance on formatting, see the comment at the bottom of this template. -->
<!---
Thanks for filing a pull request 😄 ! Before you submit, please read the following:
# Description
Search open/closed issues before submitting. Someone may have pushed the same thing before!
<!--- Describe your changes. -->
Provide a summary of your changes in the title field above.
-->

## Motivation & context
# Pull Request

<!--- What problem does this change solve? -->
<!--- Provide a link if you are addressing an open issue. -->
## 📖 Description

## Issue type checklist
<!---
Provide some background and a description of your work.
What problem does this change solve?
Is this a breaking change, chore, fix, feature, etc?
-->

<!--- What type of change are you submitting? Put an x in the box that applies: -->
### 🎫 Issues

- [ ] **Chore**: A change that does not impact distributed packages.
- [ ] **Bug fix**: A change that fixes an issue, link to the issue above.
- [ ] **New feature**: A change that adds functionality.
<!---
* List and link relevant issues here.
-->

**Is this a breaking change?**
- [ ] This change causes current functionality to break.
## 👩‍💻 Reviewer Notes

<!--- If yes, describe the impact. -->
<!---
Provide some notes for reviewers to help them provide targeted feedback and testing.
**Adding or modifying component(s) in `@microsoft/fast-components` checklist**
Do you recommend a smoke test for this PR? What steps should be followed?
Are there particular areas of the code the reviewer should focus on?
-->

<!-- Do your changes add or modify components in the @microsoft/fast-components package? Put an x in the box that applies: -->
## 📑 Test Plan

- [ ] I have added a new component
- [ ] I have modified an existing component
- [ ] I have updated the [definition file](https://github.com/Microsoft/fast/blob/master/packages/web-components/fast-components/CONTRIBUTING.md#definition)
- [ ] I have updated the [configuration file](https://github.com/Microsoft/fast/blob/master/packages/web-components/fast-components/CONTRIBUTING.md#configuration)
<!---
Please provide a summary of the tests affected by this work and any unique strategies employed in testing the features/fixes.
-->

## ✅ Checklist

## Process & policy checklist
### General

<!--- Review the list and check the boxes that apply. -->
<!--- Review the list and put an x in the boxes that apply. -->

- [ ] I have included a change request file using `$ yarn change`
- [ ] I have added tests for my changes.
- [ ] I have tested my changes.
- [ ] I have updated the project documentation to reflect my changes.
- [ ] I have read the [CONTRIBUTING](https://github.com/Microsoft/fast/blob/master/CONTRIBUTING.md) documentation and followed the [standards](https://www.fast.design/docs/community/code-of-conduct/#our-standards) for this project.

<!---
Formatting guidelines:
Accepted peer review title format:
<type>: <description>
Example titles:
chore: add unit tests for all components
feat: add a border radius to button
fix: update design system to use 3px border radius
### Component-specific

<type> is required to be one of the following:
<!--- Review the list and put an x in the boxes that apply. -->
<!--- Remove this section if not applicable. -->

- chore: A change that does not impact distributed packages.
- fix: A change which fixes an issue.
- feat: A that adds functionality.
<description> is required for the CHANGELOG and speaks to what the user gets from this PR:
- [ ] I have added a new component
- [ ] I have modified an existing component
- [ ] I have updated the [definition file](https://github.com/Microsoft/fast/blob/master/packages/web-components/fast-components/CONTRIBUTING.md#definition)
- [ ] I have updated the [configuration file](https://github.com/Microsoft/fast/blob/master/packages/web-components/fast-components/CONTRIBUTING.md#configuration)

- Be concise.
- Use all lowercase characters.
- Use imperative, present tense (e.g. `add` not `adds`.)
- Do not end your description with a period.
- Avoid redundant words.
## ⏭ Next Steps

For additional information regarding working on FAST, check out our documentation site:
https://www.fast.design/docs/community/contributor-guide
<!---
If there is relevant follow-up work to this PR, please list any existing issues or provide brief descriptions of what you would like to do next.
-->

0 comments on commit 19c550d

Please sign in to comment.