Skip to content

Commit

Permalink
package: add new GitHub issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jooy2 committed Dec 13, 2024
1 parent 6e5eb46 commit a5f586c
Show file tree
Hide file tree
Showing 9 changed files with 112 additions and 28 deletions.
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# These are supported funding model platforms

github: jooy2
custom: ['https://jooy2.com/donate']
custom: ['https://cdget.com/donate']
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: 'Bug report'
description: Report a bug in this project.
labels: ['bug']
body:
- type: markdown
attributes:
value: |
Before creating an issue, please read the following:
- Read the `README.md` file on the project page or the documentation file and compare your code to the intent of the project.
- Search to see if the same issue already exists, and keep the title concise and accurate so that it's easy for others to understand and search for.
- Please create a separate issue for each type of issue.
- For modular projects, make sure you're using the latest version of the module.
- Please be as detailed as possible and write in English so that we can handle your issue quickly.
- type: textarea
attributes:
label: Describe the bug
description: |
For the issue you are experiencing, please describe in detail what you are seeing, the error message, and the impact of the issue. If you are able to reproduce the issue, please list the steps in order. You can attach an image or video if necessary.
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
description: Describe how it should be handled when it's normal behavior or what needs to be fixed.
validations:
- type: input
attributes:
label: Your environment - System OS
description: Please describe the full range of OSes you are experiencing the issue with, preferably including the version.
placeholder: Windows 11, macOS 15.x, Linux Ubuntu 24.04, Android 15, iOS 16...
validations:
- type: input
attributes:
label: Your environment - Web Browser
description: If relevant, please describe the web browser you are currently using.
placeholder: Google Chrome, Microsoft Edge, Mozilla Firefox...
validations:
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
#contact_links:
# - name: GitHub Community Support
# url: https://github.com/orgs/community/discussions
# about: Please ask and answer questions here.
# - name: GitHub Security Bug Bounty
# url: https://bounty.github.com/
# about: Please report security vulnerabilities here.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: 'Feature request'
description: Report a feature request in this project.
labels: ['enhancement']
body:
- type: markdown
attributes:
value: |
Before creating an issue, please read the following:
- Search to see if the same issue already exists, and keep the title concise and accurate so that it's easy for others to understand and search for.
- Please create a separate issue for each type of issue.
- Please be as detailed as possible and write in English so that we can handle your issue quickly.
- type: textarea
attributes:
label: Describe the feature
description: Feel free to describe any features or improvements you would like to see. You can attach text or images of examples, behavior, etc. from other projects to elaborate.
validations:
required: true
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/fix_typo.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: 'Fix typo request'
description: Request to fix a typo or bad translation in this project
labels: ['typo']
body:
- type: markdown
attributes:
value: |
Before creating an issue, please read the following:
- Search to see if the same issue already exists, and keep the title concise and accurate so that it's easy for others to understand and search for.
- Please create a separate issue for each type of issue.
- Please be as detailed as possible and write in English so that we can handle your issue quickly.
- type: textarea
attributes:
label: Describe the issue
description: Please describe where the typo occurs and a list of text that needs to be corrected.
validations:
required: true
24 changes: 24 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!--
Thank you for contributing to the project. Your contribution will be reviewed and approved after appropriate review.
Please read the caveats below to ensure a fast merge.
-->

## Pull request checklist

You should familiarize yourself with the files `README.md`, `CONTRIBUTING.md`, and `CODE_OF_CONDUCT.md` in the root of your project.

- If an issue has been created for this, add `(fixes #{ISSUE_NUMBER})` to the end of the commit description. In `{ISSUE_NUMBER}`, please include the relevant issue number.
- If you need to update or add to the article, please update the relevant content. If a multilingual article exists, you should update all relevant content in your own language, except for translations.
- Add or update test code if it exists and is needed. Also, verify that the tests pass.
- If this PR is not yet complete, keep the PR in draft status. If it's no longer valid, close the PR with an explanation.

<!--
Below is a template for describing this PR. It's not required, so please delete the content below if you don't need it.
-->

### What did you change?

### Why did you make the change?

### How does this work?
2 changes: 2 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ lib/
test/
CHANGELOG.md
CODE_OF_CONDUCT.md
SECURITY.md
CONTRIBUTING.md

# For development
.git*
Expand Down
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,10 @@ Options:
-h, --help output usage information
```
## Contribute
## Contributing
You can report issues on [GitHub Issue Tracker](https://github.com/jooy2/terser-glob/issues).
You can also request a pull to fix bugs and add frequently used features.
Anyone can contribute to the project by reporting new issues or submitting a pull request. For more information, please see [CONTRIBUTING.md](CONTRIBUTING.md).
## License
Copyright © 2024-2025 [CDGet](https://cdget.com) <[[email protected]](mailto:[email protected])> Released under the MIT license.
Please see the [LICENSE](LICENSE) file for more information about project owners, usage rights, and more.

0 comments on commit a5f586c

Please sign in to comment.