-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update templates and docs (#154)
* docs: update templates and docs * ci: remove job name * ci: update node version for codeql * chore: build action
- Loading branch information
1 parent
17e2232
commit 9f89707
Showing
15 changed files
with
192 additions
and
107 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
* @TAKANOME-DEV | ||
* @takanome-dev |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,47 +1,59 @@ | ||
name: Bug report | ||
description: Create a report to help us address an error. | ||
title: '[BUG] - <bug description>' | ||
labels: ['🚦 status: awaiting triage'] | ||
name: 🐛 Bug report | ||
description: Create a bug report to help us improve this action. | ||
title: 'Bug: <a short description of the bug>' | ||
labels: [👀 needs triage, 🐛 bug] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: '# Bug report' | ||
value: | | ||
Thanks for taking the time to fill out this bug report! | ||
- type: textarea | ||
id: bug_description | ||
attributes: | ||
label: What bug did you encounter? | ||
description: | | ||
Please provide a clear description of the bug. | ||
Include the steps you took to cause the bug, and an explanation of what occurred. | ||
label: Describe the bug | ||
description: A clear and concise description of what the bug is. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: behavior | ||
attributes: | ||
label: What did you expect to happen? | ||
description: What did you expect to happen instead of the current behavior? | ||
label: Steps to reproduce | ||
description: Describe how to reproduce the behavior. | ||
placeholder: | | ||
1. Go to '...' | ||
2. Click on '...' | ||
3. Scroll down to '...' | ||
4. See error | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: screenshots | ||
- type: dropdown | ||
attributes: | ||
label: Screenshots | ||
description: Attach any relevant screenshots here. | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: extra_information | ||
multiple: true | ||
label: Browsers | ||
description: Select the browsers where the issue can be reproduced (that you know of). | ||
options: | ||
- 'Chrome' | ||
- 'Firefox' | ||
- 'Safari' | ||
- 'Edge' | ||
- 'Opera' | ||
- 'Other (add additional context)' | ||
- type: input | ||
id: textarea | ||
attributes: | ||
label: Additional information | ||
description: Is there anything else we should know about this bug? | ||
validations: | ||
required: false | ||
label: Additional context (Is this in dev or production?) | ||
description: Add any other context about the problem or helpful links here. | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/TAKANOME-DEV/assign-to-me-action/blob/master/CODE_OF_CONDUCT.md) | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/takanome-dev/assign-issue-action/blob/master/CODE_OF_CONDUCT.md) | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true | ||
- type: checkboxes | ||
id: contribution | ||
attributes: | ||
label: Contributing Docs | ||
description: If you plan on contributing code please read - [Contribution Guide](https://github.com/takanome-dev/assign-issue-action/blob/master/CONTRIBUTING.md) | ||
options: | ||
- label: I agree to follow this project's Contribution Docs | ||
required: false |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
name: 🚀 Feature request | ||
description: Suggest an idea for this project 💡 | ||
title: 'Feature: <a short description of the feature request>' | ||
labels: [👀 needs triage, 💡 feature] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to fill out this feature request! | ||
- type: dropdown | ||
attributes: | ||
multiple: false | ||
label: Type of feature | ||
description: Select the type of feature request, the lowercase should also be the PR prefix. | ||
options: | ||
- '💡 Feature' | ||
- '🐛 Fix' | ||
- '📝 Documentation' | ||
- '🎨 Style' | ||
- '🧑💻 Refactor' | ||
- '🔥 Performance' | ||
- '✅ Test' | ||
- '🤖 Build' | ||
- '🔁 CI' | ||
- '📦 Chore' | ||
- '⏩ Revert' | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Current behavior | ||
description: Is your feature request related to a problem? Please describe. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Suggested solution | ||
description: Describe the solution you'd like. | ||
- type: input | ||
id: context | ||
attributes: | ||
label: Additional context | ||
description: Add any other context about the problem or helpful links here. | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/takanome-dev/assign-issue-action/blob/master/CODE_OF_CONDUCT.md) | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true | ||
- type: checkboxes | ||
id: contribution | ||
attributes: | ||
label: Contributing Docs | ||
description: If you plan on contributing code please read - [Contribution Guide](https://github.com/takanome-dev/assign-issue-action/blob/master/CONTRIBUTING.md) | ||
options: | ||
- label: I agree to follow this project's Contribution Docs | ||
required: false |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
## What type of PR is this? (check all applicable) | ||
|
||
- [ ] 💡 Feature | ||
- [ ] 🐛 Bug Fix | ||
- [ ] 📝 Documentation Update | ||
- [ ] 🎨 Style | ||
- [ ] 🧑💻 Code Refactor | ||
- [ ] 🔥 Performance Improvements | ||
- [ ] ✅ Test | ||
- [ ] 🤖 Build | ||
- [ ] 🔁 CI | ||
- [ ] ⏩ Revert | ||
|
||
## Description | ||
|
||
<!-- | ||
Please do not leave this blank | ||
This PR [adds/removes/fixes/replaces] the [feature/bug/etc]. | ||
--> | ||
|
||
## Related Tickets & Documents | ||
|
||
<!-- | ||
Please use this format link issue numbers: Fixes #123 | ||
https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword | ||
--> | ||
|
||
## Mobile & Desktop Screenshots/Recordings | ||
|
||
<!-- Visual changes require screenshots --> | ||
|
||
## Added tests? | ||
|
||
- [ ] 👍 yes | ||
- [ ] 🙅 no, because they aren't needed | ||
- [ ] 🙋 no, because I need help | ||
|
||
## Added to documentation? | ||
|
||
- [ ] 📜 README.md | ||
- [ ] 📕 storybook | ||
- [ ] 🙅 no documentation needed | ||
|
||
## [optional] What gif best describes this PR or how it makes you feel? | ||
|
||
<!-- note: PRs with deleted sections will be marked invalid --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,7 +6,6 @@ on: | |
|
||
jobs: | ||
ci: | ||
name: Lint / Build / Test | ||
runs-on: ubuntu-latest | ||
|
||
strategy: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.