Skip to content

Commit

Permalink
setup github meta files
Browse files Browse the repository at this point in the history
  • Loading branch information
kazupon committed May 22, 2024
1 parent 9bba294 commit e4c4a02
Show file tree
Hide file tree
Showing 11 changed files with 438 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: kazupon
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: πŸ› Bug report
description: Report an issue
labels: ['status: review needed']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: bug-description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
placeholder: Bug description
validations:
required: true
- type: input
id: reproduction
attributes:
label: Reproduction
description: A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is **required**, otherwise the issue might be closed without further notice. [**Why & How?**](https://antfu.me/posts/why-reproductions-are-required)
placeholder: Reproduction
validations:
required: true
- type: textarea
id: system-info
attributes:
label: System Info
description: Output of `npx envinfo --system --binaries --browsers`
render: Shell
placeholder: System, Binaries, Browsers
validations:
required: true
- type: dropdown
id: package-manager
attributes:
label: Used Package Manager
description: Select the used package manager
options:
- npm
- yarn
- pnpm
- other (if you use other package manager, please describe at the `Additional context`)
- n/a
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Any other context or screenshots about the bug report here.
- type: checkboxes
id: checkboxes
attributes:
label: Validations
description: Before submitting the issue, please make sure you do the following
options:
- label: Follow our [Code of Conduct](https://github.com/kazupon/.github/blob/main/CODE_OF_CONDUCT.md)
required: true
- label: Read the [Contributing Guide](https://github.com/kazupon/textlint-rule-no-period-on-paragraph-end/blob/main/CONTRIBUTING.md).
required: true
- label: Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
required: true
- label: Check that this is a concrete bug. For Q&A, please open a GitHub Discussion instead.
required: true
- label: The provided reproduction is a [minimal reproducible](https://stackoverflow.com/help/minimal-reproducible-example) of the bug.
required: true
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
contact_links:
- name: πŸ™Œ Contribution Guide
url: https://github.com/kazupon/textlint-rule-no-period-on-paragraph-end/blob/main/CONTRIBUTING.md
about: Please read through before making contributions.
- name: ⁉️ Why and How to make a reproduction?
url: https://antfu.me/posts/why-reproductions-are-required
about: Reproduction is very important for maintainer to help on your issues!
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: πŸš€ New feature proposal
description: Propose a new feature
labels: [feature]
body:
- type: markdown
attributes:
value: |
Thanks for your interest in the project and taking the time to fill out this feature report!
- type: textarea
id: feature-description
attributes:
label: Clear and concise description of the problem
description: 'As a developer using textlint-rule-no-period-on-paragraph-end. I want [goal / wish] so that [benefit]. If you intend to submit a PR for this issue, tell us in the description. Thanks!'
validations:
required: true
- type: textarea
id: suggested-solution
attributes:
label: Suggested solution
description: 'In module [xy] we could provide following implementation...'
validations:
required: true
- type: textarea
id: alternative
attributes:
label: Alternative
description: Clear and concise description of any alternative solutions or features you've considered.
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Any other context or screenshots about the feature request here.
- type: checkboxes
id: checkboxes
attributes:
label: Validations
description: Before submitting the issue, please make sure you do the following
options:
- label: Follow our [Code of Conduct](https://github.com/kazupon/.github/blob/main/CODE_OF_CONDUCT.md)
required: true
- label: Read the [Contributing Guide](https://github.com/kazupon/textlint-rule-no-period-on-paragraph-end/blob/main/CONTRIBUTING.md).
required: true
- label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
required: true
22 changes: 22 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!-- DO NOT IGNORE THE TEMPLATE!
Thank you for contributing!
Before submitting the PR, please make sure you do the following:
- Read the [Contributing Guide](https://github.com/kazupon/textlint-rule-no-period-on-paragraph-end/blob/main/CONTRIBUTING.md).
- Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
- Provide a description in this PR that addresses **what** the PR is solving, or reference the issue that it solves (e.g. `fixes #123`).
- Ideally, include relevant tests that fail without this PR but pass with it.
-->

### Description

<!-- Please insert your description here and provide especially info about the "what" this PR is solving -->

### Linked Issues

### Additional context

<!-- e.g. is there anything you'd like reviewers to focus on? -->
87 changes: 87 additions & 0 deletions .github/labels.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
- name: feature
description: Includes new features
color: 'ffff00'
- name: bug
description: Includes new features
color: 'ee0701'
- name: improvement
description: Includes backwards-compatible fixes
color: '1d76db'
- name: breaking
description: Includes backwards-incompatible fixes
color: 'b60205'
- name: refactoring
description: A code change that neither fixes a bug nor adds a feature
color: 'fbca04'
- name: security
description: Security fixes
color: 'b60205'
- name: documentation
description: Includes documetation fixes
color: '5319e7'
- name: example
description: Includes example and demo code fixes
color: 'db0875'
- name: deprecated
description: Includes deprecate fixes
color: 'f7ffa8'
- name: performance
description: Includes performance fixes
color: 'cc317c'
- name: i18n
description: Includes internationalization fixes
color: 'ffd412'
- name: a11y
description: Inlucdes accessibility fixes
color: '0000ff'
- name: dependency
description: Includes dependency fixes
color: 'ffbce7'
- name: todo
description: todo tasks
color: 'c2e0c6'
- name: duplicate
description: This issue or Pull Request already exists
color: 'ededed'
- name: help wanted
description: Extra attention is needed
color: 'e99695'
- name: good first issue
description: Good for newcomers
color: '7057ff'
- name: 'status: abandoned'
description: The issue or Pull Request is wontfix
color: '000000'
- name: 'status: blocked'
description: Progress on the issue is Blocked
color: 'ee0701'
- name: 'status: in progress'
description: Work in Progress
color: 'cccccc'
- name: 'status: proposal'
description: Request for comments
color: 'd4c5f9'
- name: 'status: pull request welcome'
description: Welcome to Pull Request
color: '2E7733'
- name: 'status: review needed'
description: Request for review
color: 'fbca04'
- name: 'status: need more repro codes or info'
description: Lacks enough info to make progress
color: 'F9C90A'
- name: '🧹 p1-chore'
description: 'Priority 1: no change in change code behavior'
color: '#FDDFD7'
- name: '🍰 p2-nice-to-have'
description: "Priority 2: nothing is broken but it's worth addressing"
color: '#0e8a16'
- name: 'πŸ”¨ p3-minor-bug'
description: 'Priority 3: a bug in an edge case that only affects very specific usage'
color: '#fbca04'
- name: '❗ p4-important'
description: 'Priority 4: bugs that violate documented behavior, or significantly impact perf'
color: '#d93f0b'
- name: 'πŸ”₯ p5-urgent'
description: 'Priority 5: build-breaking bugs that affect most users and should be fixed ASAP'
color: '#ee0701'
45 changes: 45 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
changelog:
exclude:
labels:
- ignore-for-release
authors:
- octocat
- renovate[bot]
categories:
- title: 🌟 Features
labels:
- feature
- title: πŸ› Bug Fixes
labels:
- bug
- title: πŸ’₯ Breaking Changes
labels:
- breaking
- title: ⚠️ Deprecated Features
labels:
- deprecated
- title: ⚑ Improvement Features
labels:
- improvement
- title: πŸ”’ Security Fixes
labels:
- security
- title: πŸ“ˆ Performance Fixes
labels:
- performance
- title: πŸ“οΈ Documentations
labels:
- documentation
- title: πŸ‘• Refactoring
labels:
- refactoring
- title: 🍭 Examples
labels:
- example
- title: 🌐 β™Ώ Internationalization or Accessibility Fixes
labels:
- a11y
- i18n
- title: πŸͺ„ Others
labels:
- chore
36 changes: 36 additions & 0 deletions .github/reproduire/needs-reproduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
Thank you for your feadback! Would you be able to provide a reproduction πŸ™

<details>
<summary>More info</summary>

### Why do I need to provide a reproduction?

Reproductions make it possible for us to triage and fix issues quickly with a
relatively small team. It helps us discover the source of the problem, and also
can reveal assumptions you or we might be making.

### What will happen?

If you've provided a reproduction, we'll remove the label and try to reproduce
the issue. If we can, we'll mark it as a bug and prioritise it based on its
severity and how many people we think it might affect.

If `status: need more repro codes or info` labeled issues don't receive any
substantial activity (e.g., new comments featuring a reproduction link), we'll
close them. That's not because we don't care! At any point, feel free to comment
with a reproduction and we'll reopen it.

### How can I create a reproduction?

We have a couple of templates for starting with a minimal reproduction:

A public GitHub repository is also perfect. πŸ‘Œ

Please ensure that the reproduction is as **minimal** as possible.

You might also find these other articles interesting and/or helpful:

- [The Importance of Reproductions](https://antfu.me/posts/why-reproductions-are-required)
- [How to Generate a Minimal, Complete, and Verifiable Example](https://stackoverflow.com/help/mcve)

</details>
Loading

0 comments on commit e4c4a02

Please sign in to comment.