Skip to content

Commit 4b28f25

Browse files
authored
chore: update issue templates (#2206)
* feat: update issue templates * remove old issue template, add new pull request template
1 parent f34fc4b commit 4b28f25

File tree

4 files changed

+135
-63
lines changed

4 files changed

+135
-63
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 43 deletions
This file was deleted.
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
name: "\U0001F680 Feature request"
3+
about: Suggest an idea for this project
4+
title: 'feat:'
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Delete not needed sections below.
12+
-->
13+
14+
### Description
15+
<!--
16+
What problem are you facing, or what improvement are you suggesting?
17+
- Clearly describe the problem or need.
18+
- Explain why this feature would be useful.
19+
-->
20+
21+
### User Story
22+
<!--
23+
Describe the feature from the perspective of the user. Use the following format:
24+
- As a [type of user], I want to [do something], so that [reason/benefit].
25+
26+
Examples:
27+
- As a developer, I want to see detailed error logs, so that I can debug issues more effectively.
28+
- As a user, I want to be able to subscribe to a content topic without manually specifying a peer.
29+
-->
30+
31+
### Proposed Solution / Feature Design
32+
<!--
33+
Describe how the feature should work.
34+
- Provide a high-level summary of the solution.
35+
- Include details on the behavior, user interaction, and functionality.
36+
-->
37+
38+
#### Optional: Diagram or Draft of Design
39+
<!--
40+
If applicable, include visual aids or drafts to clarify your proposal.
41+
- Attach diagrams or design drafts to illustrate your idea.
42+
43+
Use Mermaid syntax - https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams
44+
-->
45+
46+
### Notes
47+
<!--
48+
Anything relevant:
49+
- issues or previous features;
50+
- discussion threads;
51+
- docs;
52+
- features in other projects;
53+
-->
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
name: "\U0001FAB3 Bug report"
3+
about: Create a report about a problem, observation or feedback.
4+
title: 'bug: '
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Delete not needed sections below.
12+
-->
13+
14+
### Description
15+
<!--
16+
Provide a clear and concise description of the bug.
17+
- What is happening?
18+
- What did you expect to happen?
19+
-->
20+
21+
### Expected Behavior
22+
<!--
23+
Describe what you expected to happen.
24+
-->
25+
26+
### Steps to Reproduce
27+
<!--
28+
Steps to reproduce the behavior:
29+
1. Go to '...'
30+
2. Click on '...'
31+
3. Scroll down to '...'
32+
4. See error
33+
-->
34+
35+
### Environment Details
36+
<!--
37+
Include details about your environment, such as:
38+
- Version of js-waku packages
39+
- Browser/Node.js version
40+
- Operating System
41+
- Any other context that might be relevant
42+
-->
43+
44+
<details>
45+
<summary>Logs</summary>
46+
47+
<!--
48+
Include any relevant logs or error messages here.
49+
Ensure sensitive information is redacted.
50+
51+
Add following flag: `debug=waku:*`
52+
- In browser to `localStorage`.
53+
- In NodeJS as ENV.
54+
-->
55+
56+
[Paste logs here]
57+
58+
</details>

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,30 @@
1-
## Problem
2-
1+
### Problem / Description
32
<!--
4-
Describe in details the problem or scenario that this PR is fixing.
5-
6-
If this is a feature addition or change, then focus on the WHY you are making the change.
7-
E.g.: As a user of my dApp, I want to know that X happened when I do Y.
8-
9-
If this is a bug fix, please describe why the old behavior was problematic.
3+
What problem does this PR address?
4+
Clearly describe the issue or feature the PR aims to solve.
105
-->
116

12-
## Solution
13-
14-
<!-- describe the new behavior -->
15-
16-
## Notes
7+
### Solution
8+
<!--
9+
Describe how the problem is solved in this PR.
10+
- Provide an overview of the changes made.
11+
- Highlight any significant design decisions or architectural changes.
12+
-->
1713

18-
<!-- Remove items that are not relevant -->
14+
### Notes
15+
<!--
16+
Additional context, considerations, or information relevant to this PR.
17+
- Are there known limitations or trade-offs in the solution?
18+
- Include links to related discussions, documents, or references.
19+
-->
20+
- Resolves
21+
- Related to
1922

20-
- Resolves <issue number>
21-
- Related to <link to specs>
23+
---
2224

23-
Contribution checklist:
24-
- [ ] covered by unit tests;
25-
- [ ] covered by e2e test;
26-
- [ ] add `!` in title if breaks public API;
25+
#### Checklist
26+
- [ ] Code changes are **covered by unit tests**.
27+
- [ ] Code changes are **covered by e2e tests**, if applicable.
28+
- [ ] **Dogfooding has been performed**, if feasible.
29+
- [ ] A **test version has been published**, if required.
30+
- [ ] All **CI checks** pass successfully.

0 commit comments

Comments
 (0)