hinterland/documentation
2
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix: description example

Browse Source
This commit is contained in:
yukkop
2025-02-02 00:58:15 +00:00
parent 0db3cd6bcc
commit 0f9edbdd67
1 changed files with 23 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ISSUE.md
+23 -16
View File
@@ -20,6 +20,8 @@ Issue titles should follow the format:
Issue descriptions should provide enough context and detail to understand and address the issue effectively. Issue descriptions should provide enough context and detail to understand and address the issue effectively.
### Structure: ### Structure:
may vary by `issue type`
1. **Overview**: A brief summary of the issue. 1. **Overview**: A brief summary of the issue.
2. **Steps to Reproduce**: (For bugs) Detailed steps to replicate the issue. 2. **Steps to Reproduce**: (For bugs) Detailed steps to replicate the issue.
3. **Expected Behavior**: What should happen. 3. **Expected Behavior**: What should happen.
@@ -27,22 +29,22 @@ Issue descriptions should provide enough context and detail to understand and ad
5. **Additional Information**: Any other relevant details, screenshots, or logs. 5. **Additional Information**: Any other relevant details, screenshots, or logs.
### Example: ### Example:
``` ```markdown
**Overview:** # Overview
The application crashes when attempting to open a note that is empty. The application crashes when attempting to open a note that is empty.
**Steps to Reproduce:** # Steps to Reproduce
1. Create a new note without adding any content. 1. Create a new note without adding any content.
2. Save the note. 2. Save the note.
3. Attempt to open the newly created empty note. 3. Attempt to open the newly created empty note.
**Expected Behavior:** # Expected Behavior
The empty note opens without any issues. The empty note opens without any issues.
**Actual Behavior:** # Actual Behavior
The application crashes with an "IndexOutOfBoundsException". The application crashes with an "IndexOutOfBoundsException".
**Additional Information:** # Additional Information
- Occurs on version 1.2.3 - Occurs on version 1.2.3
- Stack trace attached below. - Stack trace attached below.
``` ```
@@ -51,16 +53,21 @@ The application crashes with an "IndexOutOfBoundsException".
Apply appropriate issue type to categorize issues. Apply appropriate issue type to categorize issues.
### Common Issue Type: ### Common Issue Type:
- **Feature**: For new features - **Feature**: A request, idea, or new functionality
- **Bug**: For reporting bugs or issues - **Bug**: An unexpected problem or behavior
- **Refactor**: For code refactoring task - **Refactor**: Code refactoring
- **Task**: For miscellaneous tasks - **Task**: A specific piece of miscellaneous work
- **Performance**: For performance improvements - **Performance**: Performance improvements
- **Documentation**: For documentation-related tasks - **Documentation**: Documentation-related tasks
- **Test**: For task related to testing - **Test**: Task related to testing
- **Build**: For build system or dependency updates - **Build**: Build system or dependency updates
- **CI**: For continuous integration configurations - **CI**: Continuous integration configurations
- **Revert**: For reverting changes - **Revert**: Reverting changes
## Priority
- P0
- P1
- P2
## Milestones ## Milestones
Assign issues to milestones to track progress toward releases or date. Assign issues to milestones to track progress toward releases or date.