Skip to content

Commit

Permalink
Add Issue Template
Browse files Browse the repository at this point in the history
  • Loading branch information
ajaynegi45 committed Sep 30, 2024
1 parent 9eb276c commit 772e72c
Show file tree
Hide file tree
Showing 6 changed files with 185 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# These are supported funding model platforms

github: [ajaynegi45]
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
polar: # Replace with a single Polar username
buy_me_a_coffee: ajaynegi
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
75 changes: 75 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
name: Report a Bug 🐞
description: Help us improve by reporting any issues you encounter.
title: "[BUG] Brief description"
labels: ["status: awaiting triage"]
#assignees: ' '
body:
- type: checkboxes
id: duplicates
attributes:
label: Is this a new issue?
description: Please confirm you've checked that this issue hasn't been reported before.
options:
- label: I have searched "open" and "closed" issues, and this is not a duplicate.
required: true

- type: textarea
id: description
attributes:
label: Bug Description
description: Please provide a clear description of the issue. You can explain it in your own way if preferred.
placeholder: |
Please describe the bug in detail. For example:
- What happened?
- Where did it happen?
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: Outline the steps to reproduce the issue. If unsure, just provide any relevant details.
placeholder: |
If you know the steps, you can follow this format:
1. Go to [page or feature]
2. [Describe action taken]
3. [Describe what went wrong]
If unsure, you can explain what you were doing or what you expected to happen.
validations:
required: false

- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Attach any screenshots that might help clarify the issue (if applicable).
placeholder: Upload or drag and drop images here.
validations:
required: false

- type: dropdown
id: assignee
attributes:
label: Would you like to work on this issue?
options:
- "Yes"
- "No"
validations:
required: true

- type: textarea
id: implementation-plan
attributes:
label: Implementation Plan
description: If you selected "Yes" above, please describe how you would approach fixing this issue (Optional).
placeholder: Provide a brief plan or any initial thoughts on fixing the bug.
validations:
required: false

- type: markdown
attributes:
value: |
Thank you for reporting this bug! Please ensure you've filled out all the required sections to help us address the issue as efficiently as possible.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Feature Request 💡
description: Have a new idea or feature? Let us know...
title: "[FEATURE] <brief description>"
labels: ["status: awaiting triage"]

body:
- type: checkboxes
id: duplicates
attributes:
label: Is this feature already requested?
description: Ensure this feature hasn't been suggested before.
options:
- label: I have checked "open" and "closed" issues, and this is not a duplicate.
required: true

- type: textarea
id: problem
attributes:
label: Problem or Missing Functionality
description: Briefly describe the problem or the missing functionality that this feature would address.
placeholder: "For ex: I often encounter [specific problem] when using [current feature or lack thereof]. Implementing this feature would improve [specific aspect or workflow] by [explain how it will help]."
validations:
required: false

- type: textarea
id: solution
attributes:
label: Feature Description
description: Describe the feature you're suggesting and how it would solve the problem. Include any relevant details or references.
placeholder: "For ex: I suggest adding [describe the feature] that will [explain its impact]. This feature could be similar to [mention any known implementations or inspirations], which helps by [describe how it benefits the users]."
validations:
required: true

- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Attach any screenshots that might help illustrate the feature or its need (Optional).
placeholder: "If applicable, drag and drop images here or click to upload. Screenshots can help clarify your suggestion by showing the current issue or how the feature might look."
validations:
required: false

- type: dropdown
id: work_on_issue
attributes:
label: Would you like to work on this feature?
options:
- "Yes"
- "No"
validations:
required: true

- type: textarea
id: implementation_plan
attributes:
label: Implementation Plan
description: If you selected "Yes" above, briefly describe how you plan to implement this feature (Optional).
placeholder: "For example: I plan to start by [outline your steps], using [mention any tools, libraries, or frameworks]. This will help ensure the feature is developed efficiently and meets the intended purpose."
validations:
required: false

- type: markdown
attributes:
value: |
Thank you for suggesting a new feature! Please ensure you've filled out all the required sections to help us evaluate your suggestion effectively.
1 change: 1 addition & 0 deletions .github/semantic.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
titleOnly: true
28 changes: 28 additions & 0 deletions .github/workflows/code-quality.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Code Quality and Formatting

on: [push, pull_request]

jobs:
lint:
name: Lint Code
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: '18'

- name: Install dependencies
run: npm ci

- name: Run ESLint
run: npm run lint

# - name: Check for formatting issues
# run: |
# npm install prettier --save-dev
# npx prettier --check '**/*.{ts,tsx,js,jsx,css,scss,md,html,json}'

0 comments on commit 772e72c

Please sign in to comment.