Skip to content

Commit

Permalink
docs: create issue and pull request template
Browse files Browse the repository at this point in the history
  • Loading branch information
lumirlumir committed Sep 14, 2024
1 parent c1c99ce commit 3767337
Show file tree
Hide file tree
Showing 5 changed files with 136 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: '🐛Bug'
about: Report a reproducible bug or regression.
title: 'Bug: '
---

<!--
Please provide a clear and concise description of what the bug is.
Include screenshots if needed.
-->

## Steps To Reproduce

1.
1.

<!--
Your bug will get fixed much faster if we can run your code.
Issues without reproduction steps or code examples may be immediately closed as not actionable.
-->

Link to code example:

<!--
Provide a CodeSandbox, link to a repository on GitHub, or minimal code example that reproduces the problem.
You may provide a screenshot of the application if you think it is relevant to your bug report.
Here are some tips for providing a minimal example: https://stackoverflow.com/help/mcve.
-->

## The Current Behavior

## The Expected Behavior
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/others.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: '🔧Other Issue'
about: Report any other issue that does not fit into the predefined categories.
title: 'Other: '
---

<!--
Please provide a clear and concise description of the issue. Include any relevant details or context.
-->

## Description

<!--
Describe the issue in detail. Include any relevant information or context that might help in understanding the issue.
-->

## Additional Context

<!--
Provide any additional context or details about the issue. This can include links, screenshots, or other relevant information.
-->
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/suggestion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: '💡Suggestion'
about: Suggest a new feature or improvement.
title: 'Suggestion: '
---

<!--
Please provide a clear and concise description of your suggestion.
Explain the motivation behind it and how it would benefit the project.
-->

## Description

<!--
What is your suggestion? Be detailed and include any relevant information that would help understand the context and benefits.
-->

## Motivation

<!--
Why do you think this suggestion is needed? Describe the problem you are trying to solve or the improvement you would like to see.
-->

## Proposed Solution

<!--
How do you propose to implement this suggestion? If you have ideas on how it can be achieved, please share them here.
-->

## Additional Context

<!--
Add any other context or screenshots about the feature request here.
-->
40 changes: 40 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<!--
Thanks for submitting a pull request!
We appreciate you spending the time to work on these changes.
Please provide enough information so that others can review your pull request.
Before making a pull request, read our contributing guidelines in `README.md`.
-->

# Title

<!--
Erase `Title` and write down the proper title for this pull request.
-->

## Summary

<!--
Explain the **motivation** for making this change. What existing problem does the pull request solve?
-->

## Details

<!--
Explain the details you made on this pull request.
The more detailed it is, the more likely it will be approved.
-->

## How did you test this change?

<!--
Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots or videos.
How exactly did you verify that your PR solves the issue you wanted to solve?
If you leave this empty, your PR will very likely be closed.
-->

## Resolved Issues

<!--
If you fixed problems in issues, write down the numbers of issues.
Example: #1, #2, ...
-->
9 changes: 9 additions & 0 deletions .github/sync-client.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
lumirlumir/lumirlumir-configs:
- source: ./.github/sync-client.yml
dest: ./clients/web-blog.yml
# ./.github/ISSUE_TEMPLATE
- source: ./.github/ISSUE_TEMPLATE/bug.md
dest: ./configs/.github/ISSUE_TEMPLATE/bug.md
- source: ./.github/ISSUE_TEMPLATE/others.md
dest: ./configs/.github/ISSUE_TEMPLATE/others.md
- source: ./.github/ISSUE_TEMPLATE/suggestion.md
dest: ./configs/.github/ISSUE_TEMPLATE/suggestion.md
# ./.github/workflows
- source: ./.github/workflows/bump.yml
dest: ./configs/.github/workflows/bump.yml
Expand All @@ -17,6 +24,8 @@ lumirlumir/lumirlumir-configs:
dest: ./configs/.github/FUNDING.yml
- source: ./.github/labeler.yml
dest: ./configs/.github/labeler.yml
- source: ./.github/PULL_REQUEST_TEMPLATE.md
dest: ./configs/.github/PULL_REQUEST_TEMPLATE.md
- source: ./.github/release.yml
dest: ./configs/.github/release.yml
# ./.husky
Expand Down

0 comments on commit 3767337

Please sign in to comment.