Skip to content

Commit

Permalink
update labels and add issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
ayoisaiah committed Apr 24, 2024
1 parent 12ba6d5 commit e94e683
Show file tree
Hide file tree
Showing 5 changed files with 166 additions and 0 deletions.
78 changes: 78 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
name: File a bug report
description: Report an issue with F2
body:
- type: markdown
attributes:
value: |
Thank you for submitting a bug report for F2. To assist us in replicating and resolving your issue, kindly fill the following fields as per their descriptions.
Before proceeding, we recommend checking the [list of open bug reports](https://github.com/ayoisaiah/f2/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Aupdated-desc) to confirm that your particular problem has not already been reported.
If you do not find your issue listed, please proceed with your bug report. Your contribution is highly appreciated!
- type: checkboxes
id: issue-not-common
attributes:
label: Tick this box to confirm you have reviewed the above.
options:
- label: I've discovered a new issue with F2.
required: true

- type: textarea
id: f2-version
attributes:
label: What version of F2 are you using?
description: Enter the output of `f2 --version`. Please ensure you're using the [latest stable release](https://github.com/ayoisaiah/f2/releases/latest) before filing a bug report.
placeholder: ex. F2 version v1.9.1
validations:
required: true

- type: textarea
id: install-method
attributes:
label: How did you install F2?
placeholder: ex. Go, Arch AUR, GitHub binary, NPM
validations:
required: false

- type: textarea
id: operating-system
attributes:
label: What operating system are you using F2 on?
description: Enter your operating system name and version.
placeholder: ex. Fedora 39, Windows 11
validations:
required: true

- type: textarea
id: description
attributes:
label: Describe your bug.
description: Give a high level description of the bug.
placeholder: ex. F2 overwrites a file without using the `--allow-overwrites` flag
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: What are the steps to reproduce the behavior?
description: |
Please describe the steps to trigger the bug including a reproducible example.
validations:
required: true

- type: textarea
id: actual-behavior
attributes:
label: What behaviour did you observe?
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: What is the expected behaviour?
description: What do you think F2 should have done instead?
validations:
required: true
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
blank_issues_enabled: true
contact_links:
- name: Ask a question
about: |
Seek help or discuss anything related to F2.
url: https://github.com/ayoisaiah/f2/discussions/new
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Propose a new feature or enhancement
about: Suggest a new feature or enhancement for F2
title: ''
labels: ''
assignees: ''
---

#### Describe your feature request

Please provide a detailed description of the desired behavior and the reasons
behind your request. Also include examples illustrating how the proposed feature
would be utilized if implemented.

Before making a feature request, take a moment to review the
[existing requests](https://github.com/ayoisaiah/f2/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22new+feature%22++label%3A%22enhancement%22)
to confirm that it hasn't already been suggested.
43 changes: 43 additions & 0 deletions .github/labels.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
- name: bug
color: d93f0b
description: Something isn't working as expected

- name: new feature
color: "159818"
description: Requests to add new functionality

- name: enhancement
color: c5def5
description: Changes to an existing feature

- name: documentation
color: e0d216
description: Related to the docs

- name: internal
color: f4ca81
description: Changes that aren't user-facing

- name: "tag: duplicate"
color: "2e3234"
description: Similar issue already exists

- name: "tag: in-progress"
color: "2e3234"
description: Task is in progress

- name: "tag: completed"
color: "2e3234"
description: Issue was completed successfully

- name: "tag: wontfix"
color: "2e3234"
description: Proposal will not be implemented

- name: "tag: help wanted"
color: "2e3234"
description: Maintainer is looking for help with the issue

- name: "tag: good first issue"
color: "2e3234"
description: Issues suitable for new contributors
22 changes: 22 additions & 0 deletions .github/workflows/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Update issue labels

on:
workflow_dispatch:
pull_request:
branches:
- master
paths:
- .github/labels.yml
- .github/workflows/labeler.yml

jobs:
labeler:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Run Labeler
uses: crazy-max/ghaction-github-labeler@v5
with:
github-token: ${{ secrets.GITHUB_TOKEN }}

0 comments on commit e94e683

Please sign in to comment.