-
Notifications
You must be signed in to change notification settings - Fork 547
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: improve issue templates (#4311)
* enh: expand context for bug report template * enh: expand feature request template * feat: add enhancement issue template * feat: add meta task issue template * tweaks * edits
- Loading branch information
Showing
4 changed files
with
273 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,82 @@ | ||
--- | ||
name: Ignite CLI bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: bug | ||
assignees: '' | ||
name: Ignite CLI Bug Report | ||
about: Create a report to help identify and fix issues | ||
title: "FIX: " | ||
labels: type:bug | ||
assignees: "" | ||
--- | ||
|
||
**Describe the bug** | ||
Tell us what you were doing and provide a clear and concise description of issue you encountered. | ||
<!-- | ||
Please adapt sections as needed while keeping core descriptions clear and detailed. These sections are guidance, but accurate information will help ensure effective handling of the issue or request. | ||
--> | ||
|
||
### Context: | ||
|
||
<!-- | ||
Provide the background and context for the bug. | ||
Consider: | ||
- What were you trying to accomplish when you encountered the issue? | ||
- Were you following a specific tutorial, guide, or workflow? | ||
- Is this bug blocking you from continuing development, or is it a minor inconvenience? | ||
- Were there any recent changes to your environment (e.g., new versions of Ignite CLI, updates to your code, changes in dependencies)? | ||
- Was the issue related to a specific Ignite CLI command, chain configuration, or part of the Cosmos SDK? | ||
--> | ||
|
||
#### Describe the Bug: | ||
|
||
<!-- | ||
Provide a clear and concise description of the bug, explaining what happened and how it deviates from expected behavior. | ||
Consider: | ||
- What specifically went wrong? (e.g., command failed, wrong output, unexpected behavior) | ||
- Is this a regression from a previous version or a new issue you've encountered? | ||
--> | ||
|
||
### Steps to Reproduce: | ||
|
||
<!-- Provide step-by-step instructions to reproduce the issue. Be as detailed as possible to help us replicate the bug. --> | ||
|
||
**To reproduce** | ||
Steps to reproduce the behavior: | ||
1. | ||
2. | ||
3. | ||
|
||
### Expected Behavior: | ||
|
||
<!-- | ||
Describe what you expected to happen when following the steps outlined above. | ||
Consider: | ||
- What would the correct or expected output/behavior have been? | ||
- How should the CLI or chain have responded under normal circumstances? | ||
--> | ||
|
||
### Actual Behavior: | ||
|
||
<!-- | ||
Describe what actually happened instead of the expected behavior. | ||
Consider: | ||
- Did the command fail, or did the behavior deviate from what you expected? | ||
- Were there any specific error messages or logs that appeared? | ||
- Did the issue affect your chain configuration, build process, or other aspects of development? | ||
--> | ||
|
||
### Environment Details: | ||
|
||
<!-- Provide details about your environment: OS, Ignite CLI version, etc. --> | ||
|
||
- **OS:** | ||
- **Ignite Version:** Provide the output of the `ignite version` command. | ||
- **Go Version:** Provide the output of the `go version` command. | ||
- **Other Relevant Tools:** (e.g., node, npm, or other dependencies, if applicable) | ||
|
||
### Notes: | ||
|
||
**What version are you using?** | ||
<!-- | ||
Add any other context or information that might help us understand the issue, such as error logs, screenshots, or relevant code snippets. | ||
Provide the output of the `ignite version` command. | ||
Consider: | ||
- Are there any logs or stack traces that might help diagnose the issue? | ||
- Is this issue tied to specific chain configurations, modules, or dependencies? | ||
- Have you attempted any workarounds or fixes? | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
--- | ||
name: Ignite CLI Enhancement Request | ||
about: Suggest improvements or updates to existing features | ||
title: "UPDATE: " | ||
labels: type:enh | ||
assignees: "" | ||
--- | ||
|
||
<!-- | ||
Please adapt sections as needed while keeping core descriptions clear and detailed. These sections are guidance, but accurate information will help ensure effective handling of the issue or request. | ||
--> | ||
|
||
### Context: | ||
|
||
<!-- | ||
Provide the background and context for the enhancement request. | ||
Consider: | ||
- What part of the system are you looking to improve, and why? | ||
- Is this enhancement focused on performance, usability, developer experience, or another aspect of the tool? | ||
- Are you aiming to extend, refine, or refactor existing functionality? | ||
- Is this enhancement based on feedback from users, team discussions, or personal experience using the Ignite CLI? | ||
- Has the current functionality been problematic, confusing, or insufficient in some way? | ||
--> | ||
|
||
### Proposed Enhancement: | ||
|
||
<!-- | ||
Provide a clear and concise description of the improvement or update. | ||
Consider: | ||
- How does this enhancement improve or optimize existing functionality? | ||
- Will this update require changes to existing commands, configuration files, or dependencies? | ||
- How will this benefit developers using Ignite CLI (e.g., better performance, improved usability, easier configuration)? | ||
--> | ||
|
||
#### Alternatives Considered: | ||
|
||
<!-- | ||
List any alternative solutions or approaches you've considered and why they may not be suitable. | ||
Consider: | ||
- Could this be addressed through a different enhancement or workaround? | ||
- Would refactoring current code or extending existing functionality be better than introducing new features? | ||
- Are there risks or trade-offs involved with the proposed solution (e.g., complexity, maintenance burden)? | ||
--> | ||
|
||
### Desired Outcome: | ||
|
||
<!-- | ||
Describe what success looks like after the enhancement is implemented. | ||
Consider: | ||
- What specific improvement should be evident? (e.g., reduced build times, better error handling, cleaner code) | ||
- How will this change be measured or evaluated (e.g., performance benchmarks, usability feedback)? | ||
--> | ||
|
||
### Notes: | ||
|
||
<!-- | ||
Add any other relevant information or context that could help in implementing the enhancement request. | ||
Consider: | ||
- Are there specific examples or use cases that illustrate why this enhancement is important? | ||
- Can you provide any relevant diagrams, mockups, or code snippets? | ||
- Have you encountered any issues or challenges when using the existing feature that this enhancement would resolve? | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,73 @@ | ||
--- | ||
name: Ignite CLI feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: request | ||
assignees: '' | ||
|
||
name: Ignite CLI Feature Request | ||
about: Suggest a new feature or component | ||
title: "INIT: " | ||
labels: type:feat, request | ||
assignees: "" | ||
--- | ||
|
||
**Is your feature request related to a problem or issue you encountered? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
<!-- | ||
Please adapt sections as needed while keeping core descriptions clear and detailed. These sections are guidance, but accurate information will help ensure effective handling of the issue or request. | ||
--> | ||
|
||
### Context: | ||
|
||
<!-- | ||
Describe the context for the feature request. What problem are you trying to solve, or what opportunity are you aiming to capture? | ||
Consider: | ||
- Is this request about making it easier for developers to use the CLI? | ||
- Is it related to improving the user experience for bootstrapping Cosmos SDK chains? | ||
- Is this intended to solve an ongoing issue or pain point encountered during the development process? | ||
- Is this feature request in response to community feedback or specific needs identified during testing? | ||
If you're unsure whether this should be a feature request, consider starting a new Discussion topic instead. If this is more about generating ideas, brainstorming, or honing in on a solution, starting a discussion might be more appropriate. | ||
Refer to the guidelines in our [Contributing Guide](./CONTRIBUTING.md). | ||
--> | ||
|
||
### Proposed Solution: | ||
|
||
<!-- | ||
Provide a clear and concise description of the solution or feature you would like to see implemented. | ||
Consider: | ||
- How will this solution be integrated into the existing Ignite CLI workflow? | ||
- Will this require changes to the configuration files (e.g., `config.yml`, `app.toml`)? | ||
- Are there any specific commands or flags that this feature would add or modify? | ||
- How will this feature impact the developer experience and the chain bootstrapping process? | ||
--> | ||
|
||
#### Alternatives Considered: | ||
|
||
<!-- | ||
List any alternative solutions or approaches you've considered and why they may not be suitable. | ||
Consider: | ||
- Could this feature be an Ignite App instead of being part of the core CLI tool? | ||
- Would this require significant maintenance effort or ongoing support? | ||
- Is there existing functionality in the CLI or Cosmos SDK that could be extended or refactored instead of introducing new code? | ||
- Have you explored alternative patterns, third-party tools, or existing Cosmos modules that could address the need? | ||
- Would this feature introduce technical debt, and if so, what would be the trade-offs? | ||
--> | ||
|
||
### Expected Outcome: | ||
|
||
<!-- | ||
Explain what success would look like. What behavior or result would indicate that this feature is working as expected? | ||
Consider: | ||
- What is the tangible impact of this feature? (e.g., faster setup times, easier customization, reduced developer friction) | ||
- What are the measurable improvements? (e.g., improved performance, enhanced flexibility) | ||
- What areas of the Ignite CLI or connected Cosmos SDK modules will this feature touch or improve? | ||
--> | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
### Notes: | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
<!-- | ||
Include any other relevant information or context that could help in understanding the feature request, such as related issues, mockups, or potential use cases. | ||
Include other useful information that helps us understand your request. | ||
Consider: | ||
- Are there related issues or bugs that this feature would resolve? | ||
- Can you provide any screenshots, diagrams, or code snippets to illustrate your request? | ||
- Is there a timeline or specific version where this feature should be prioritized? | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
--- | ||
name: Ignite CLI Meta Task | ||
about: Create a larger, multi-step task or initiative | ||
title: "META: " | ||
labels: epic | ||
assignees: "" | ||
--- | ||
|
||
<!-- | ||
Please adapt sections as needed while keeping core descriptions clear and detailed. These sections are guidance, but accurate information will help ensure effective handling of the issue or request. | ||
--> | ||
|
||
### Context: | ||
|
||
<!-- | ||
Provide the background and context for this meta task. | ||
Consider: | ||
- What larger goal or initiative is this meta task addressing? | ||
- Why is it necessary to break this initiative into smaller sub-tasks or actions? | ||
- Is this meta task part of a larger project or roadmap, and how does it align with ongoing development priorities? | ||
- Are there specific milestones or deadlines associated with this meta task? | ||
--> | ||
|
||
### Acceptance Criteria: | ||
|
||
<!-- | ||
Define what needs to happen for the entire meta task to be considered complete. | ||
Consider: | ||
- What are the concrete deliverables for each sub-task? | ||
- How will you know when the overall goal has been met? | ||
- Are there specific tests, benchmarks, or other criteria that need to be met for each sub-task to be considered complete? | ||
--> | ||
|
||
<!-- Break down the meta task into smaller, actionable tasks. Each task should be achievable on its own. | ||
- [ ] Task 1: Description of the task | ||
- [ ] Task 2: Description of the task | ||
- [ ] Task 3: Description of the task | ||
--> | ||
|
||
### Dependencies or Related Tasks: | ||
|
||
<!-- | ||
List any dependencies or tasks that are related to this meta task. | ||
Consider: | ||
- Are there other issues, features, or enhancements that need to be completed before this meta task can begin? | ||
- Is this meta task dependent on any external factors such as third-party tools, upstream changes, or external collaborators? | ||
- Are there ongoing discussions or other meta tasks related to this one that should be tracked or considered? | ||
--> | ||
|
||
### Notes: | ||
|
||
<!-- | ||
Include any relevant links, documentation, or other context that would help in completing this meta task. | ||
Consider: | ||
- Are there relevant design documents, architecture diagrams, or technical specs that should be referenced? | ||
- Are there specific constraints or challenges (e.g., time, resources, external dependencies) that could impact the completion of this meta task? | ||
- Are there potential blockers or risks that might need to be addressed as part of this meta task? | ||
--> |