diff --git a/ISSUE.md b/ISSUE.md index f0ef31f..8269fa3 100644 --- a/ISSUE.md +++ b/ISSUE.md @@ -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. ### Structure: +may vary by `issue type` + 1. **Overview**: A brief summary of the issue. 2. **Steps to Reproduce**: (For bugs) Detailed steps to replicate the issue. 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. ### Example: -``` -**Overview:** +```markdown +# Overview 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. 2. Save the note. 3. Attempt to open the newly created empty note. -**Expected Behavior:** +# Expected Behavior The empty note opens without any issues. -**Actual Behavior:** +# Actual Behavior The application crashes with an "IndexOutOfBoundsException". -**Additional Information:** +# Additional Information - Occurs on version 1.2.3 - Stack trace attached below. ``` @@ -51,16 +53,21 @@ The application crashes with an "IndexOutOfBoundsException". Apply appropriate issue type to categorize issues. ### Common Issue Type: -- **Feature**: For new features -- **Bug**: For reporting bugs or issues -- **Refactor**: For code refactoring task -- **Task**: For miscellaneous tasks -- **Performance**: For performance improvements -- **Documentation**: For documentation-related tasks -- **Test**: For task related to testing -- **Build**: For build system or dependency updates -- **CI**: For continuous integration configurations -- **Revert**: For reverting changes +- **Feature**: A request, idea, or new functionality +- **Bug**: An unexpected problem or behavior +- **Refactor**: Code refactoring +- **Task**: A specific piece of miscellaneous work +- **Performance**: Performance improvements +- **Documentation**: Documentation-related tasks +- **Test**: Task related to testing +- **Build**: Build system or dependency updates +- **CI**: Continuous integration configurations +- **Revert**: Reverting changes + +## Priority +- P0 +- P1 +- P2 ## Milestones Assign issues to milestones to track progress toward releases or date.