Skip to content

Commit

Permalink
docs: update templates and docs (#154)
Browse files Browse the repository at this point in the history
* docs: update templates and docs

* ci: remove job name

* ci: update node version for codeql

* chore: build action
  • Loading branch information
takanome-dev authored Aug 23, 2023
1 parent 17e2232 commit 9f89707
Show file tree
Hide file tree
Showing 15 changed files with 192 additions and 107 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* @TAKANOME-DEV
* @takanome-dev
66 changes: 39 additions & 27 deletions .github/ISSUE_TEMPLATE/bug.yml
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
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/config.yml

This file was deleted.

21 changes: 14 additions & 7 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
name: Documentation
name: 📝 Documentation Request
description: Request an update to invalid/outdated documentation
title: '[DOCS] - <description>'
labels: ['🚦 status: awaiting triage']
title: 'Docs: <a short description of the documentation error>'
labels: ['👀 needs triage', '📝 documentation']
body:
- type: markdown
attributes:
value: '# Incorrect Documentation'
value: |
Thanks for taking the time to fill out this documentation request!
- type: textarea
id: doc_error_description
attributes:
label: What is incorrect in the documentation?
description: Please explain the information that is incorrect in the documentation, and why you think it needs to be updated.
validations:
required: true
- type: textarea
id: expected_information
attributes:
label: What should that text say?
description: Provide the information that the documentation should actually contain instead of the incorrect content.
Expand All @@ -31,7 +30,15 @@ body:
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
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
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
37 changes: 0 additions & 37 deletions .github/ISSUE_TEMPLATE/others.yml

This file was deleted.

46 changes: 46 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
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 -->
1 change: 0 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ on:

jobs:
ci:
name: Lint / Build / Test
runs-on: ubuntu-latest

strategy:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
fail-fast: false
matrix:
language: ['javascript']
node-version: [16.x]
node-version: [18.x]

steps:
- name: Checkout repository
Expand Down
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ Please read the [CODE of CONDUCT](CODE_OF_CONDUCT.md).

First, fork the repository to your own account and run the following command:

- Clone your repo: `git clone https://github.com/<your_name>/assign-to-me-action`
- Change directory to the working dir: `cd assign-to-me-action`
- Install the dependencies: `npm i`
- Clone your repo: `git clone https://github.com/<your_name>/assign-issue-action`
- Change directory to the working dir: `cd assign-issue-action`
- Install the dependencies: `npm ci`

## Issue

If you see an open issue you would like to work on, just comment `/assign-to-me` and the action will assign the issue to you 😉
If you see an open issue you would like to work on, just comment `.take` and the action will assign the issue to you 😉
Issues that are not assigned are assumed open, and to avoid conflicts, please assign yourself before beginning work on any issues.

> [!NOTE]
Expand Down Expand Up @@ -43,7 +43,7 @@ Make sure to change the PR title in something like: `fix: correct typo` or `feat

## Pull Request Reviews

All pull requests require a review before being merged. Most reviews will come from [@takanome_dev](https://github.com/TAKANOME-DEV).
All pull requests require a review before being merged. Most reviews will come from [@takanome_dev](https://github.com/takanome-dev).

If your pull request is approved, it will be merged.

Expand Down
Loading

0 comments on commit 9f89707

Please sign in to comment.