Skip to content

Commit 3873dbd

Browse files
committed
chore: update github templates
1 parent b514d49 commit 3873dbd

6 files changed

Lines changed: 52 additions & 72 deletions

File tree

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
3+
about: Report a reproducible problem
44
---
55

6-
<!-- If you delete this template this issue is very likely to be closed. -->
6+
<!-- Please provide enough detail to reproduce the problem. -->
77

8-
## Current behaviour
8+
## Current Behavior
99

10-
<!-- Tell us which problem you are facing which might be caused by a bug. -->
10+
<!-- What happened? Include the exact output or error message when possible. -->
1111

12-
## Expected behaviour
12+
## Expected Behavior
1313

14-
<!-- If not included in current behaviour please explain what should happen instead. -->
14+
<!-- What did you expect to happen? -->
1515

16-
### Reproduction Example
16+
## Reproduction
1717

18-
<!-- Please provide a minimal example how to reproduce your problem. -->
18+
<!-- Provide a minimal example how to reproduce your problem. -->
1919

20-
## Environment
20+
```js
2121

22-
<!-- Tell us versions of your environment: -->
22+
```
2323

24-
- OS (inc. version): [macOS, Linux, Windows]
25-
- version of Node.js:
26-
- version of the Plugin:
24+
## Environment
2725

28-
## Additional context
26+
<!-- Fill in your environment. -->
2927

30-
<!-- Add any other context about the problem here. -->
28+
- OS:
29+
- Node.js:
30+
- Package version:
3131

32-
## Appreciation for the useful project
32+
## Additional Context
3333

34-
- [ ] After the problem is resolved, do not forget to give a star ⭐
34+
<!-- Add any other context about the problem here. -->
Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
11
---
22
name: Feature request
3-
about: Suggest an idea for this project
3+
about: Suggest an improvement or new capability
44
---
55

6-
<!-- If you delete this template this issue is very likely to be closed. -->
6+
## Problem
77

8-
## Feature request
8+
<!-- What problem does this solve? -->
99

10-
**What is motivation or use case for adding/changing the behavior?**
11-
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
10+
## Proposed Solution
1211

13-
**Describe the solution you'd like**
14-
<!-- A clear and concise description of what you want to happen. -->
12+
<!-- What would you like to happen? -->
1513

14+
## Alternatives
1615

17-
**Describe alternatives you've considered**
18-
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
16+
<!-- Which alternatives or workarounds have you considered? -->
1917

20-
## Appreciation for the useful project
18+
## Additional Context
2119

22-
- [ ] After the feature is implemented, do not forget to give a star ⭐
20+
<!-- Add examples, screenshots, links, or related issues. -->

‎.github/ISSUE_TEMPLATE/Other.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,12 @@ name: Custom issue
33
about: Something else
44
---
55

6-
<!-- Bug reports and Feature requests must use other templates, or will be closed -->
6+
<!-- Use the bug report or feature request template when possible. -->
77

8-
## Appreciation for the useful project
8+
## Topic
99

10-
- [ ] Do not forget to give a star ⭐
10+
<!-- What would you like to discuss or ask? -->
11+
12+
## Details
13+
14+
<!-- Add any relevant context, links, or examples. -->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 17 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,26 @@
1-
## Types of changes
1+
## Summary
22

3-
<!-- Please place an `x` in all [ ] that apply: -->
3+
<!-- What changed and why? -->
44

5-
This PR contains a:
5+
## Type of change
66

7-
- [ ] **bugfix**
8-
- [ ] new **feature**
9-
- [ ] **code refactor**
10-
- [ ] **test update** <!-- if bug or feature is checked, this should be too -->
11-
- [ ] **typo fix**
12-
- [ ] **docs change**
13-
- [ ] **breaking change** <!-- fix or feature that change existing functionality -->
7+
- [ ] Bug fix
8+
- [ ] Feature
9+
- [ ] Refactor
10+
- [ ] Tests
11+
- [ ] Documentation
12+
- [ ] Build or CI
13+
- [ ] Breaking change
1414

15-
## Motivation / Use-Case
15+
## Testing
1616

17-
<!--
18-
Please explain the motivation or use-case for your change.
19-
What existing problem does the PR solve?
20-
If this PR addresses an issue, please link to the issue.
21-
-->
17+
<!-- Which commands did you run? -->
2218

23-
## Breaking Changes
24-
25-
<!--
26-
If this PR introduces a breaking change, please describe the impact and a
27-
migration path for existing applications.
28-
-->
29-
30-
## Additional Info
31-
32-
---
19+
- [ ] `npm test`
3320

3421
## Checklist
3522

36-
<!-- Go over all the following points, and place an `x` in all the boxes that apply. -->
37-
38-
- [ ] My code follows the code style of this project.
39-
- [ ] My change requires a change to the documentation.
40-
- [ ] I have updated the documentation accordingly.
41-
- [ ] I have updated the **CHANGELOG.md**.
42-
- [ ] I have read the **CONTRIBUTING** document.
43-
- [ ] I have added tests to cover my changes.
44-
- [ ] All new and existing tests passed.
45-
46-
## Appreciation for the useful project
47-
48-
- [ ] Do not forget to give a star ⭐
23+
- [ ] Documentation updated when needed
24+
- [ ] Changelog updated when needed
25+
- [ ] Tests added or updated when needed
26+
- [ ] Breaking changes are described with migration notes

‎.github/workflows/test.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ jobs:
7575
NODE_OPTIONS: --unhandled-rejections=strict
7676

7777
- name: Submit coverage data to codecov
78-
uses: codecov/codecov-action@v3
78+
uses: codecov/codecov-action@v5
7979
with:
8080
flags: test
8181
token: ${{ secrets.CODECOV_TOKEN }}

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,8 @@ Ansis is the fastest when using 2 or more styles, which is the common real-world
103103
<h1></h1>
104104

105105
> 🎯 **You might also like**
106+
> - [`ansilight`](https://github.com/webdiscus/ansilight) - Truecolor syntax highlighter for the terminal with 256 `highlight.js` [themes](https://github.com/webdiscus/ansilight/blob/master/docs/theme-gallery.md)
106107
> - [`flaget`](https://github.com/webdiscus/flaget) - CLI argument parsing. A smaller (5 kB) and faster alternative to [`yargs-parser`](https://www.npmjs.com/package/yargs-parser) (85 kB)
107-
> - [`HTML bundler`](https://github.com/webdiscus/html-bundler-webpack-plugin) - Plugin for Webpack to generate static sites from templates (html, ejs, hbs, pug, ...)
108108
109109

110110
<a name="alternatives"></a>

0 commit comments

Comments
 (0)