Skip to content

Commit db14270

Browse files
JoaopeukoJoaopeuko
committed
docs: Add github template
1 parent a4ebcd8 commit db14270

File tree

13 files changed

+205
-9
lines changed

13 files changed

+205
-9
lines changed

‎.github/FUNDING.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
11
github: Joaopeuko
2-
patreon: joaopeuko

‎.github/ISSUE_TEMPLATE/build.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: "[build] Build Request"
2+
description: Changes related to the build system, dependencies, or configuration updates (e.g., build scripts, Dockerfiles, etc.).
3+
title: "build: "
4+
labels: [build]
5+
projects: []
6+
body:
7+
- type: input
8+
id: root_path
9+
attributes:
10+
label: "Where?"
11+
description: "Provide path from the root of the repository."
12+
placeholder: "mqpy/"
13+
14+
- type: textarea
15+
id: requested_change
16+
attributes:
17+
label: Describe the Requested Change
18+
description: Provide a detailed description of the proposed change.
19+
placeholder: e.g., Bump package X from 1.0.0 to 1.0.1 or update build script Y.

‎.github/ISSUE_TEMPLATE/chore.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: "[chore] Chore Request"
2+
description: Routine tasks or administrative updates not affecting code functionality (e.g., updates to documentation, configurations, or non-functional dependencies).
3+
title: "chore: "
4+
labels: [chore]
5+
projects: []
6+
body:
7+
- type: input
8+
id: root_path
9+
attributes:
10+
label: "Where?"
11+
description: "Provide path from the root of the repository."
12+
placeholder: "mqpy/"
13+
14+
- type: textarea
15+
id: task_description
16+
attributes:
17+
label: Describe the Task
18+
description: Specify the task or update that should be performed.
19+
placeholder: e.g., Add secrets to GitHub Secret, update CI config, or clean up old logs.

‎.github/ISSUE_TEMPLATE/ci.yaml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: "[ci] CI Request"
2+
description: Changes or updates related to continuous integration (CI) and deployment pipelines.
3+
title: "ci: "
4+
labels: [ci]
5+
projects: []
6+
body:
7+
- type: input
8+
id: root_path
9+
attributes:
10+
label: "Where?"
11+
description: "Provide path from the root of the repository."
12+
placeholder: "mqpy/"
13+
- type: textarea
14+
id: ci_modification
15+
attributes:
16+
label: What CI modification is needed?
17+
description: Provide a clear description of the issue or the part of the CI/CD pipeline that requires modification.
18+
placeholder: e.g., Fix failing build step, update deployment script, or add new test stage.

‎.github/ISSUE_TEMPLATE/docs.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: "[docs] Documentation Request"
2+
description: Request documentation for functions, scripts, modules, or any other code-related areas that lack clarity.
3+
title: "docs: "
4+
labels: [docs]
5+
projects: []
6+
body:
7+
- type: input
8+
id: root_path
9+
attributes:
10+
label: "Where?"
11+
description: "Provide path from the root of the repository."
12+
placeholder: "mqpy/"
13+
14+
- type: textarea
15+
id: unclear_section
16+
attributes:
17+
label: What is unclear?
18+
description: Specify the part of the code or documentation that is unclear. Include details about what information is missing or confusing.
19+
placeholder: e.g., "The purpose of function X is unclear" or "More details needed about how module Y interacts with Z."

‎.github/ISSUE_TEMPLATE/feat.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: "[feat] Task Request"
2+
description: Request a task or feature to be added to the project.
3+
title: "feat: "
4+
labels: [feat]
5+
projects: []
6+
body:
7+
- type: input
8+
id: root_path
9+
attributes:
10+
label: "Where?"
11+
description: "Provide path from the root of the repository."
12+
placeholder: "mqpy/"
13+
14+
- type: textarea
15+
id: task
16+
attributes:
17+
label: Task Description
18+
description: Provide a clear and concise description of what needs to be done.
19+
placeholder: Describe the problem or proposed solution.

‎.github/ISSUE_TEMPLATE/fix.yaml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: "[fix] Bug Fix Request"
2+
description: Request a bug fix or patch to resolve an issue in the codebase.
3+
title: "fix: "
4+
labels: [bug, fix]
5+
projects: []
6+
body:
7+
- type: input
8+
id: root_path
9+
attributes:
10+
label: "Where?"
11+
description: "Provide path from the root of the repository."
12+
placeholder: "mqpy/"
13+
14+
- type: textarea
15+
id: steps_to_reproduce
16+
attributes:
17+
label: Steps to Reproduce
18+
description: Provide the steps or code needed to reproduce the bug. Include specific instructions or a code snippet if possible.
19+
placeholder: e.g., "1. Go to page A, 2. Click button B, 3. Observe behavior C."
20+
21+
- type: textarea
22+
id: proposed_solution
23+
attributes:
24+
label: Proposed Solution
25+
description: Suggest a solution to fix the bug. Include any alternative approaches you've considered.
26+
placeholder: e.g., "Fix the validation in X module" or "Add a check for Y before proceeding."

‎.github/ISSUE_TEMPLATE/perf.yaml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: "[perf] Performance Refactor Request"
2+
description: Request for performance optimizations or refactors to make the code more efficient or faster.
3+
title: "perf: "
4+
labels: [perf]
5+
projects: []
6+
body:
7+
- type: input
8+
id: root_path
9+
attributes:
10+
label: "Where?"
11+
description: "Provide path from the root of the repository."
12+
placeholder: "mqpy/"
13+
14+
- type: textarea
15+
id: area_for_improvement
16+
attributes:
17+
label: Area for Performance Improvement
18+
description: Specify the part of the codebase or system that requires optimization. Explain why it needs improvement and describe the current performance issue as the proposed solution.
19+
placeholder: e.g., "The sorting algorithm in module X is slow when handling large datasets."
20+

‎.github/ISSUE_TEMPLATE/refactor.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: "[refactor] Code Refactor Request"
2+
description: Request for code refactoring to enhance code quality, structure, and maintainability.
3+
title: "refactor: "
4+
labels: [refactor]
5+
projects: []
6+
body:
7+
- type: input
8+
id: root_path
9+
attributes:
10+
label: "Where?"
11+
description: "Provide path from the root of the repository."
12+
placeholder: "mqpy/"
13+
14+
- type: textarea
15+
id: area_to_refactor
16+
attributes:
17+
label: What needs to be refactored?
18+
description: Provide a clear and concise description of the parts of the codebase that should be refactored. Explain any issues with the current implementation, such as complexity, readability, or maintainability problems.
19+
placeholder: e.g., "The function X is too complex and difficult to maintain."

‎.github/ISSUE_TEMPLATE/style.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: "[style] Style Refactor Request"
2+
description: Request for code style and formatting changes without altering functionality.
3+
title: "style: "
4+
labels: [style]
5+
projects: []
6+
body:
7+
- type: input
8+
id: root_path
9+
attributes:
10+
label: "Where?"
11+
description: "Provide path from the root of the repository."
12+
placeholder: "mqpy/"
13+
14+
- type: textarea
15+
id: style_issues
16+
attributes:
17+
label: What style improvements are needed?
18+
description: Provide a clear description of the style or formatting issues in the code that need to be addressed. Focus on readability, consistency, or adherence to coding standards.
19+
placeholder: e.g., "Inconsistent indentation in module X" or "Variable names in function Y don’t follow the naming convention."

‎.github/ISSUE_TEMPLATE/test.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: "[test] Test Request"
2+
description: Suggest updates or additions to test cases, including creating new tests or modifying existing ones.
3+
title: "test: "
4+
labels: [test]
5+
projects: []
6+
body:
7+
- type: input
8+
id: root_path
9+
attributes:
10+
label: "Where?"
11+
description: "Provide path from the root of the repository."
12+
placeholder: "mqpy/"
13+
14+
- type: textarea
15+
id: test_scope
16+
attributes:
17+
label: What needs to be tested?
18+
description: Provide a clear and concise description of the functionality or components that require testing. Specify if new test cases should be added or if existing ones need modification.
19+
placeholder: e.g., "Test the new feature X in module Y" or "Modify the test for function Z to cover edge cases."

‎.github/dependabot.yaml

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,7 @@ updates:
99
patterns:
1010
- "*"
1111

12-
- package-ecosystem: 'github-actions'
13-
directory: '/'
12+
- package-ecosystem: "github-actions"
13+
directory: "/.github/workflows/"
1414
schedule:
15-
interval: 'daily'
16-
17-
- package-ecosystem: 'docker'
18-
directory: '/'
19-
schedule:
20-
interval: 'daily'
15+
interval: "daily"

‎.github/pull_request_template.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
### Description
2+
3+
4+
5+
Fixes (issue)

0 commit comments

Comments
 (0)