Skip to content

Commit

Permalink
Merge pull request #1149 from amperser/chore/housekeeping
Browse files Browse the repository at this point in the history
chore: repo housekeeping
  • Loading branch information
suchow committed May 19, 2021
2 parents 9a94cbe + 41ff89c commit 372ebf0
Show file tree
Hide file tree
Showing 8 changed files with 306 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
@@ -0,0 +1,34 @@
---
name: Bug Report
about: Report an issue
title: ''
labels: type: fix, status: awaiting-triage, bug: unconfirmed
assignees: ''

---

## Bug Description

<!-- A clear and concise description of what the bug is. -->

## Reproducible By

<!-- A step by step list on how the bug can be reproduced for examination. -->

## Expected Behavior

<!-- A clear and concise description of what you expected to happen. -->

## Logs & Screenshots

<!-- If applicable, add screenshots to help explain your problem, or
alternatively add your console logs here. -->

## Environment

<!-- This is just your OS and environment information [e.g. Ubuntu 18.04 LTS,
Node v14.14.0] -->

### Additional context

<!-- Add any other context about the problem here. -->
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/false-positive.md
@@ -0,0 +1,34 @@
---
name: False Positive Report
about: Report a false positive for a rule
title: ''
labels: type: fix, status: awaiting-triage, bug: unconfirmed, cat: false-positive
assignees: ''

---

## Bug Description

<!-- A clear and concise description of what the bug is. -->

## Reproducible By

<!-- A step by step list on how the bug can be reproduced for examination. -->

## Expected Behavior

<!-- A clear and concise description of what you expected to happen. -->

## Logs & Screenshots

<!-- If applicable, add screenshots to help explain your problem, or
alternatively add your console logs here. -->

## Environment

<!-- This is just your OS and environment information [e.g. Ubuntu 18.04 LTS,
Node v14.14.0] -->

### Additional context

<!-- Add any other context about the problem here. -->
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
@@ -0,0 +1,28 @@
---
name: Feature Request
about: Make a suggestion on a feature or improvement for the project
title: ''
labels: type: feat, status: awaiting-triage
assignees: ''

---

## This would solve...

<!-- A clear and concise description of the problem this feature request relates
to, if applicable. -->

## The implementation should look like...

<!-- A clear and concise description of how you expect this to be resolved or
implemented. -->

## I have also considered...

<!-- A clear and concise description of any alternative solutions or features
you have considered. -->

## Additional context

<!-- Add any other context, screenshots or ideas about the feature request
here. -->
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/rule-request.md
@@ -0,0 +1,27 @@
---
name: Rule Request
about: Make a suggestion on a new rule or check for proselint
title: ''
labels: type: feat, cat: new-rule, status: awaiting-triage
assignees: ''

---

## This would solve...

<!-- A clear and concise description of the linguistic problem this resolves
and relates to. -->

## And this should flag...

<!-- A few examples of things this rule should detect. -->

## But it should not flag...

<!-- A few examples of things that are similar to this rule's targeted forms
but that it should not detect (i.e. potential false positives), if any. -->

## Sources & References

<!-- Add any citations to back up the considerations and reasoning behind this
rule here. -->
34 changes: 34 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/template.md
@@ -0,0 +1,34 @@
<!--
Before submitting a Pull Request, please read our contribution guidelines, which
can be found at CONTRIBUTING.md in the repository root.
For code changes:
1. Include tests for any bug fixes or new features.
2. Ensure that tests and linting pass.
-->

## This relates to...

<!-- List the issues this resolves or relates to here (if applicable) -->

## Rationale

<!-- Briefly explain the purpose of this pull request, if not already
justifiable with the above section. If it is, you may omit this section. -->

## Changes

<!-- Write a summary or list of changes here -->

### Features

<!-- List the new features here (if applicable), or write N/A if not -->

### Bug Fixes

<!-- List the fixed bugs here (if applicable), or write N/A if not -->

### Breaking Changes and Deprecations

<!-- List the breaking changes (changes that modify the existing API) and
deprecations (removed features) here -->
14 changes: 14 additions & 0 deletions .github/dependabot.yml
@@ -0,0 +1,14 @@
version: 2
updates:
- package-ecosystem: github-actions
directory: "/"
schedule:
interval: weekly
time: "12:00"
timezone: Europe/London
- package-ecosystem: pip
directory: "/"
schedule:
interval: weekly
time: "12:00"
timezone: Europe/London
117 changes: 117 additions & 0 deletions .github/labels.yml
@@ -0,0 +1,117 @@
- name: "bug: unconfirmed"
description: Bugs that need to be reproduced.
color: 6C1010
- name: "bug: irreproducible"
description: Bugs that couldn't be triaged.
color: EEEEEE
- name: "bug: confirmed"
description: Bugs that were confirmed in triage.
color: F80000
- name: "bug: fixed"
description: Bugs that have been fixed.
color: FF8383
- name: "bug: fixed-in-next"
description: Bugs present in the current release but fixed on the main branch.
color: 36080A
- name: "type: feat"
description: Issues and PRs related to new features.
color: 26E9FF
- name: "type: fix"
description: Issues and PRs related to bugs.
color: D71F1F
- name: "type: style"
description: Issues and PRs related to stylistic code choices.
color: FFD1DC
- name: "type: refactor"
description: Issues and PRs related to code cleanup.
color: FFFF00
- name: "type: perf"
description: Issues and PRs related to performance.
color: FFFF00
- name: "type: test"
description: Issues and PRs related to unit and integration testing.
color: FFFF00
- name: "type: build"
description: Issues and PRs related to application build steps.
color: FFFF00
- name: "type: ci"
description: Issues and PRs related to continuous integration.
color: FFFF00
- name: "type: chore"
description: Issues and PRs related to changes that do not fit into other categories.
color: FFFF00
- name: "type: revert"
description: Issues and PRs related to changes that undo regressions.
color: FFFF00
- name: "priority: urgent"
description: Issues and PRs that must be resolved immediately.
color: B60205
- name: "priority: high"
description: Issues and PRs that should be resolved as soon as possible.
color: D93F0B
- name: "priority: medium"
description: Issues and PRs that should be resolved soon.
color: FBCA04
- name: "priority: low"
description: Issues and PRs that should be resolved, but can be postponed.
color: 0E8A16
- name: "priority: null"
description: Issues and PRs that are of negligible importance so may be postponed.
color: "818181"
- name: "version: major"
description: Issues and PRs with breaking changes belonging to the next major release.
color: 9A35BE
- name: "version: minor"
description: Issues and PRs with new features belonging to the next minor release.
color: D38DFA
- name: "version: patch"
description: Issues and PRs with bug fixes belonging to the next patch release.
color: 66D8EB
- name: "status: blocked"
description: Issues and PRs that cannot be resolved until others are.
color: FBCA04
- name: "status: conflicted"
description: Issues and PRs that have unresolved merge conflicts.
color: D81AFF
- name: "status: awaiting-triage"
description: Issues and PRs awaiting investigation and relabelling.
color: D81A0D
- name: "status: rejected"
description: Issues and PRs that have been denied and will not be worked on.
color: 080F1C
- name: "status: needs-help"
description: Issues and PRs that require volunteer assistance to proceed.
color: 128A0C
- name: "status: awaiting-tests"
description: Issues and PRs that require tests to proceed.
color: D93F0B
- name: "status: merge-ready"
description: PRs that are ready to merge.
color: 05F541
- name: "status: review-ready"
description: PRs that are ready for author review.
color: 05F541
- name: "status: postponed"
description: Issues and PRs that are being temporarily set aside in favour of others.
color: FBCA04
- name: "status: wip"
description: Issues and PRs that are still a work in progress.
color: F5EB6B
- name: "cat: maintenance"
description: Issues and PRs related to the maintenance of a module.
color: F5EB6B
- name: "cat: rfc"
description: Issues that propose changes, or a Request For Comments.
color: FCFCFC
- name: "cat: qna"
description: Issues that exist solely to ask a question, or a Question and Answer.
color: FCFCFC
- name: "cat: deps"
description: Issues and PRs related to dependency upgrades.
color: FCFCFC
- name: "cat: new-rule"
description: Issues and PRs related to new proselint rules.
color: FCFCFC
- name: "cat: false-positive"
description: Issues and PRs related to false positives in proselint rules.
color: FCFCFC
18 changes: 18 additions & 0 deletions .github/workflows/ci-label.yml
@@ -0,0 +1,18 @@
name: "CI: Synchronize Labels"
on:
push:
branches:
- "main"
paths:
- ".github/labels.yml"
- ".github/workflows/ci-label.yml"
jobs:
labeler:
runs-on: ubuntu-latest
steps:
- name: "[INIT] Checkout repository"
uses: actions/checkout@v2
- name: "[EXEC] Synchronize labels"
uses: crazy-max/ghaction-github-labeler@v3
with:
github-token: ${{ secrets.GITHUB_TOKEN }}

0 comments on commit 372ebf0

Please sign in to comment.