mirror of
https://github.com/logos-messaging/js-waku.git
synced 2026-01-02 13:53:12 +00:00
chore: update issue templates (#2206)
* feat: update issue templates * remove old issue template, add new pull request template
This commit is contained in:
parent
f34fc4b244
commit
4b28f250e3
43
.github/ISSUE_TEMPLATE.md
vendored
43
.github/ISSUE_TEMPLATE.md
vendored
@ -1,43 +0,0 @@
|
||||
<!-- Delete all but one category -->
|
||||
This is a **bug report/feature request/support request/change request**
|
||||
|
||||
## Problem
|
||||
|
||||
<!--
|
||||
Describe in details the problem or scenario that you are facing or trying to solve
|
||||
|
||||
If this is a feature request, then focus on the WHY you want the change.
|
||||
E.g.: As a user of my dApp, I want to know that X happened when I do Y.
|
||||
|
||||
If this is a bug report or support, please provide a code snippet that reproduces the issue or relevant steps.
|
||||
Describe the actual behavior vs expected behavior.
|
||||
Please also include logs.
|
||||
-->
|
||||
|
||||
## Proposed Solutions
|
||||
|
||||
<!--
|
||||
Describe one or several (or none) solutions to fix the problem describe above.
|
||||
|
||||
If this is a feature request, then focus on WHAT or HOW you want to see the change happen.
|
||||
Feel free to itemize requirements. E.g.:
|
||||
|
||||
- Function `foo` must return information about `bar`.
|
||||
- Function `blah` must allow me to pass argument `boo`.
|
||||
|
||||
Or describe current vs wanted behavior.
|
||||
|
||||
If this is a bug report and you know how to fix the problem, feel free to include a proposal or open a PR.
|
||||
Or feel free to omit this section.
|
||||
-->
|
||||
|
||||
## Notes
|
||||
|
||||
<!--
|
||||
Add any miscellaneous note that are relevant to issue, including but not limited to:
|
||||
|
||||
- js-waku version
|
||||
- Environment (browser software and version, system software and version)
|
||||
- Nodes connected to too (e.g. Status test fleet)
|
||||
- etc
|
||||
-->
|
||||
53
.github/ISSUE_TEMPLATE/🚀-feature-request.md
vendored
Normal file
53
.github/ISSUE_TEMPLATE/🚀-feature-request.md
vendored
Normal file
@ -0,0 +1,53 @@
|
||||
---
|
||||
name: "\U0001F680 Feature request"
|
||||
about: Suggest an idea for this project
|
||||
title: 'feat:'
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
Delete not needed sections below.
|
||||
-->
|
||||
|
||||
### Description
|
||||
<!--
|
||||
What problem are you facing, or what improvement are you suggesting?
|
||||
- Clearly describe the problem or need.
|
||||
- Explain why this feature would be useful.
|
||||
-->
|
||||
|
||||
### User Story
|
||||
<!--
|
||||
Describe the feature from the perspective of the user. Use the following format:
|
||||
- As a [type of user], I want to [do something], so that [reason/benefit].
|
||||
|
||||
Examples:
|
||||
- As a developer, I want to see detailed error logs, so that I can debug issues more effectively.
|
||||
- As a user, I want to be able to subscribe to a content topic without manually specifying a peer.
|
||||
-->
|
||||
|
||||
### Proposed Solution / Feature Design
|
||||
<!--
|
||||
Describe how the feature should work.
|
||||
- Provide a high-level summary of the solution.
|
||||
- Include details on the behavior, user interaction, and functionality.
|
||||
-->
|
||||
|
||||
#### Optional: Diagram or Draft of Design
|
||||
<!--
|
||||
If applicable, include visual aids or drafts to clarify your proposal.
|
||||
- Attach diagrams or design drafts to illustrate your idea.
|
||||
|
||||
Use Mermaid syntax - https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams
|
||||
-->
|
||||
|
||||
### Notes
|
||||
<!--
|
||||
Anything relevant:
|
||||
- issues or previous features;
|
||||
- discussion threads;
|
||||
- docs;
|
||||
- features in other projects;
|
||||
-->
|
||||
58
.github/ISSUE_TEMPLATE/🪳-bug-report.md
vendored
Normal file
58
.github/ISSUE_TEMPLATE/🪳-bug-report.md
vendored
Normal file
@ -0,0 +1,58 @@
|
||||
---
|
||||
name: "\U0001FAB3 Bug report"
|
||||
about: Create a report about a problem, observation or feedback.
|
||||
title: 'bug: '
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
Delete not needed sections below.
|
||||
-->
|
||||
|
||||
### Description
|
||||
<!--
|
||||
Provide a clear and concise description of the bug.
|
||||
- What is happening?
|
||||
- What did you expect to happen?
|
||||
-->
|
||||
|
||||
### Expected Behavior
|
||||
<!--
|
||||
Describe what you expected to happen.
|
||||
-->
|
||||
|
||||
### Steps to Reproduce
|
||||
<!--
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '...'
|
||||
3. Scroll down to '...'
|
||||
4. See error
|
||||
-->
|
||||
|
||||
### Environment Details
|
||||
<!--
|
||||
Include details about your environment, such as:
|
||||
- Version of js-waku packages
|
||||
- Browser/Node.js version
|
||||
- Operating System
|
||||
- Any other context that might be relevant
|
||||
-->
|
||||
|
||||
<details>
|
||||
<summary>Logs</summary>
|
||||
|
||||
<!--
|
||||
Include any relevant logs or error messages here.
|
||||
Ensure sensitive information is redacted.
|
||||
|
||||
Add following flag: `debug=waku:*`
|
||||
- In browser to `localStorage`.
|
||||
- In NodeJS as ENV.
|
||||
-->
|
||||
|
||||
[Paste logs here]
|
||||
|
||||
</details>
|
||||
44
.github/PULL_REQUEST_TEMPLATE.md
vendored
44
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -1,26 +1,30 @@
|
||||
## Problem
|
||||
|
||||
### Problem / Description
|
||||
<!--
|
||||
Describe in details the problem or scenario that this PR is fixing.
|
||||
|
||||
If this is a feature addition or change, then focus on the WHY you are making the change.
|
||||
E.g.: As a user of my dApp, I want to know that X happened when I do Y.
|
||||
|
||||
If this is a bug fix, please describe why the old behavior was problematic.
|
||||
What problem does this PR address?
|
||||
Clearly describe the issue or feature the PR aims to solve.
|
||||
-->
|
||||
|
||||
## Solution
|
||||
### Solution
|
||||
<!--
|
||||
Describe how the problem is solved in this PR.
|
||||
- Provide an overview of the changes made.
|
||||
- Highlight any significant design decisions or architectural changes.
|
||||
-->
|
||||
|
||||
<!-- describe the new behavior -->
|
||||
### Notes
|
||||
<!--
|
||||
Additional context, considerations, or information relevant to this PR.
|
||||
- Are there known limitations or trade-offs in the solution?
|
||||
- Include links to related discussions, documents, or references.
|
||||
-->
|
||||
- Resolves
|
||||
- Related to
|
||||
|
||||
## Notes
|
||||
---
|
||||
|
||||
<!-- Remove items that are not relevant -->
|
||||
|
||||
- Resolves <issue number>
|
||||
- Related to <link to specs>
|
||||
|
||||
Contribution checklist:
|
||||
- [ ] covered by unit tests;
|
||||
- [ ] covered by e2e test;
|
||||
- [ ] add `!` in title if breaks public API;
|
||||
#### Checklist
|
||||
- [ ] Code changes are **covered by unit tests**.
|
||||
- [ ] Code changes are **covered by e2e tests**, if applicable.
|
||||
- [ ] **Dogfooding has been performed**, if feasible.
|
||||
- [ ] A **test version has been published**, if required.
|
||||
- [ ] All **CI checks** pass successfully.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user