Skip to content

Commit

Permalink
GITHUB-IMPROVE
Browse files Browse the repository at this point in the history
  • Loading branch information
Dartvauder committed Nov 3, 2024
1 parent fa500f1 commit 302241e
Show file tree
Hide file tree
Showing 13 changed files with 458 additions and 71 deletions.
53 changes: 38 additions & 15 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: "🐛 Bug Report"
description: Create a new ticket for a bug.
description: "Create a new ticket for a bug."
title: "🐛 [BUG] - <title>"
labels: [
"bug"
Expand All @@ -9,42 +9,51 @@ body:
id: description
attributes:
label: "Description"
description: Please enter an explicit description of your issue
placeholder: Short and explicit description of your incident...
description: "Please describe the issue in detail."
placeholder: "Provide a detailed description of the issue..."
validations:
required: true

- type: textarea
id: expected_behavior
attributes:
label: "Expected Behavior"
description: "Please describe what you expected to happen."
placeholder: "Expected result..."
validations:
required: true

- type: textarea
id: reprod
attributes:
label: "Reproduction steps"
description: Please enter an explicit description of your issue
value:
render: bash
label: "Reproduction Steps"
description: "Please list the steps to reproduce the issue, one step per line."
placeholder: "1. Open app\n2. Go to settings\n3. Observe error"
validations:
required: true

- type: textarea
id: screenshot
attributes:
label: "Screenshots"
description: If applicable, add screenshots to help explain your problem.
value: |
![DESCRIPTION](LINK.png)
render: bash
description: "If applicable, add screenshots to help explain your problem."
placeholder: "Attach screenshots here..."
validations:
required: false

- type: textarea
id: logs
attributes:
label: "Logs"
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: bash
description: "Please copy and paste any relevant log output."
validations:
required: false

- type: dropdown
id: browsers
attributes:
label: "Browsers"
description: What browsers are you seeing the problem on ?
description: "What browsers are you seeing the problem on?"
multiple: true
options:
- Firefox
Expand All @@ -54,15 +63,29 @@ body:
- Opera
validations:
required: false

- type: dropdown
id: os
attributes:
label: "OS"
description: What is the impacted environment ?
description: "What is the impacted environment?"
multiple: true
options:
- Windows
- Linux
- Mac
validations:
required: false

- type: dropdown
id: priority
attributes:
label: "Priority"
description: "How critical is this issue?"
options:
- Low
- Medium
- High
- Critical
validations:
required: true
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/design_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: "🎨 Design Feedback"
description: Provide feedback on UI/UX design
title: "🎨 [Design] - <title>"
labels: [
"design"
]
body:
- type: textarea
id: description
validations:
required: true
attributes:
label: Feedback Description
description: |
Provide details about the design aspect you are giving feedback on.
- type: textarea
id: suggestion
validations:
required: false
attributes:
label: Suggested Improvements
description: |
Suggest any changes or improvements you think would enhance the design.
- type: dropdown
id: feedback-type
validations:
required: true
attributes:
label: Feedback Type
description: |
Select the type of feedback.
options:
- Usability
- Visual Design
- Accessibility
- Responsiveness
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: "📚 Documentation Request"
description: Request improvements or additions to the documentation
title: "📚 [Docs] - <title>"
labels: [
"documentation"
]
body:
- type: textarea
id: area-of-documentation
validations:
required: true
attributes:
label: Area of Documentation
description: |
Describe the specific part of the documentation you want to address.
- type: textarea
id: improvement-details
validations:
required: true
attributes:
label: Details
description: |
Explain the improvements or additions needed in the documentation.
- type: input
id: related-links
validations:
required: false
attributes:
label: Related Links
description: |
Add any links to relevant code, examples, or additional resources.
36 changes: 33 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ body:
attributes:
label: Feature request
description: |
A clear and concise description of the feature proposal
Provide a clear and concise description of the feature proposal, including what problem it solves or improvement it introduces.
- type: textarea
id: motivation
Expand All @@ -23,12 +23,42 @@ body:
description: |
Please outline the motivation for the proposal. Is your feature request related to a problem?
- type: textarea
id: contribution
validations:
required: true
attributes:
label: Your contribution
description: |
Is there any way that you could help, e.g. by submitting a PR?
Is there any way that you could help, e.g., by submitting a PR?
- type: input
id: related-links
validations:
required: false
attributes:
label: Related Links
description: |
Links to any relevant discussions, documents, or issues related to this feature request.
- type: dropdown
id: priority
validations:
required: false
attributes:
label: Priority
description: |
Indicate the urgency of the feature request.
options:
- Low
- Medium
- High

- type: textarea
id: expected-outcome
validations:
required: false
attributes:
label: Expected Outcome
description: |
Describe what success looks like if this feature is implemented. How will it improve the user experience or functionality?
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/performance_issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: "⚡ Performance Issue"
description: Report a performance issue affecting the system
title: "⚡ [Performance] - <short description>"
labels: [
"performance"
]
body:
- type: textarea
id: description
validations:
required: true
attributes:
label: Description
description: |
Describe the performance issue, including any symptoms (e.g., slow loading, high memory usage).
- type: textarea
id: steps-to-reproduce
validations:
required: false
attributes:
label: Steps to Reproduce
description: |
If possible, describe how to reproduce the issue.
- type: textarea
id: impact
validations:
required: true
attributes:
label: Impact
description: |
Describe how this issue affects users or the system.
- type: input
id: environment
validations:
required: false
attributes:
label: Environment
description: |
Specify the environment (e.g., OS, app version, hardware) where the issue occurs.
- type: dropdown
id: severity
validations:
required: false
attributes:
label: Severity
description: |
Rate the impact of this performance issue.
options:
- Low
- Medium
- High
- Critical
18 changes: 13 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,29 @@
- [ ] Bug Fix
- [ ] Optimization
- [ ] Documentation Update
- [ ] Other (please describe below)

## Description

-
- Describe what changes have been made and why. Include key points and the reasoning behind the implementation.

## Impact

- Are there any breaking changes?
- Does this require documentation or configuration updates?

## Related Tickets & Documents

-
- Related tickets (e.g., `#1234`):
- Links to documentation:

## QA Instructions & Screenshots

-
- Describe steps for testing this PR.
- If applicable, attach screenshots for clarity.

## Added/updated tests?

- [ ] Yes
- [ ] Yes, new tests have been added.
- [ ] No, and this is why:
- [ ] I need help with writing tests
- [ ] I need help with writing tests.
34 changes: 34 additions & 0 deletions .github/workflows/first-issue-labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: First Issue Labeler

on:
issues:
types: [opened]

jobs:
first-issue:
runs-on: ubuntu-latest
permissions:
issues: write

steps:
- name: Check if first contribution
id: check
uses: actions/github-script@v7
with:
script: |
const creator = context.payload.issue.user.login;
const issues = await github.rest.issues.listForRepo({
owner: context.repo.owner,
repo: context.repo.repo,
creator: creator,
state: 'all'
});
if (issues.data.length === 1) {
await github.rest.issues.addLabels({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
labels: ['good first issue']
});
}
36 changes: 36 additions & 0 deletions .github/workflows/first-pr-labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: First PR Labeler

on:
pull_request:
types: [opened]

jobs:
first-pr:
runs-on: ubuntu-latest
permissions:
pull-requests: write

steps:
- name: Check if first contribution
id: check
uses: actions/github-script@v7
with:
script: |
const creator = context.payload.pull_request.user.login;
const pullRequests = await github.rest.pulls.list({
owner: context.repo.owner,
repo: context.repo.repo,
state: 'all',
per_page: 100
});
const creatorPRs = pullRequests.data.filter(pr => pr.user.login === creator);
if (creatorPRs.length === 1) {
await github.rest.issues.addLabels({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
labels: ['good first PR']
});
}
Loading

0 comments on commit 302241e

Please sign in to comment.