docs: majore update, including new github features

This commit is contained in:
2025-01-30 20:38:21 +00:00
parent 858308f9cf
commit 0db3cd6bcc
+49 -67
View File
@@ -3,32 +3,18 @@
## Issue Title Conventions ## Issue Title Conventions
Issue titles should follow the format: Issue titles should follow the format:
```ignore ```ignore
<type>: <short description> <short description>
``` ```
### `<type>`
This should be one of:
- **Feature**: For new features
- **Bug**: For reporting bugs or issues
- **Refactor**: For code refactoring task
- **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
- **Chore**: For miscellaneous tasks
- **Revert**: For reverting changes
### `<short description>` ### `<short description>`
- Use imperative, present tense: "Add", "Fix", "Improve" - Use imperative, present tense: "Add", "Fix", "Improve"
- Keep it concise and descriptive - Keep it concise and descriptive
- Do not end with a period (`.`) - Do not end with a period (`.`)
### Examples: ### Examples:
- `Feature: Add note preview functionality` - `Add note preview functionality`
- `Bug: Fix crash when opening empty note` - `Fix crash when opening empty note`
- `Refactor: Restructure configuration module` - `Restructure configuration module`
## Issue Description Conventions ## Issue Description Conventions
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.
@@ -61,22 +47,20 @@ The application crashes with an "IndexOutOfBoundsException".
- Stack trace attached below. - Stack trace attached below.
``` ```
## Labels ## Issue Type
Apply appropriate labels to categorize and prioritize issues. Apply appropriate issue type to categorize issues.
### Common Labels: ### Common Issue Type:
- **Feature**: For new features
- ### Type: - **Bug**: For reporting bugs or issues
- `feature` - **Refactor**: For code refactoring task
- `bug` - **Task**: For miscellaneous tasks
- `refactor` - **Performance**: For performance improvements
- `documentation` - **Documentation**: For documentation-related tasks
- `performance` - **Test**: For task related to testing
- `test` - **Build**: For build system or dependency updates
- `build` - **CI**: For continuous integration configurations
- `ci` - **Revert**: For reverting changes
- `chore`
- `revert`
## Milestones ## Milestones
Assign issues to milestones to track progress toward releases or date. Assign issues to milestones to track progress toward releases or date.
@@ -92,7 +76,7 @@ Assign issues to milestones to track progress toward releases or date.
When creating an issue, use the appropriate template: When creating an issue, use the appropriate template:
### Bug Report ### Bug Report
- **Title**: `Bug: <short description>` - **Title**: `<short description>`
- **Template Sections**: - **Template Sections**:
- Overview - Overview
- Steps to Reproduce - Steps to Reproduce
@@ -100,92 +84,92 @@ When creating an issue, use the appropriate template:
- Actual Behavior - Actual Behavior
- Screenshots (if applicable) - Screenshots (if applicable)
- Environment (OS, software vesions if possible) - Environment (OS, software vesions if possible)
- **Labels**: - **Issue Type**:
- `bug` - `Bug`
### Feature Request ### Feature Request
- **Title*: `Feature: <short description>` - **Title*: `<short description>`
- **Template Sections**: - **Template Sections**:
- Overview - Overview
- Motivation - Motivation
- Proposed Solution - Proposed Solution
- Alternatives Considered - Alternatives Considered
- Additional Context - Additional Context
- **Labels**: - **Issue Type**:
- `feature` - `Feature`
### Refactor Task ### Refactor Task
- **Title**: `Refactor: <short description>` - **Title**: `<short description>`
- **Template Sections**: - **Template Sections**:
- Overview - Overview
- Reason for Refactoring - Reason for Refactoring
- Areas of Impact - Areas of Impact
- Expected Benefits - Expected Benefits
- **Labels**: - **Issue Type**:
- `refactor` - `Refactor`
### Documentation Task ### Documentation Task
- **Title**: `Documentation: <short description>` - **Title**: `<short description>`
- **Template Sections**: - **Template Sections**:
- Overview - Overview
- Pages or Sections Affected - Pages or Sections Affected
- Proposed Changes - Proposed Changes
- **Labels**: - **Issue Type**:
- `documentation` - `Documentation`
### Performance Improvement ### Performance Improvement
- **Title**: `Performance: <short description>` - **Title**: `<short description>`
- **Template Sections**: - **Template Sections**:
- Overview - Overview
- Current Performance - Current Performance
- Expected Performance - Expected Performance
- Impact - Impact
- Additional Information - Additional Information
- **Labels**: - **Issue Type**:
- `performance` - `Performance`
### Test Task ### Test Task
- **Title**: `Test: <short description>` - **Title**: `<short description>`
- **Template Sections**: - **Template Sections**:
- Overview - Overview
- Areas to Test - Areas to Test
- Test Type - Test Type
- Motivation - Motivation
- Additional Context - Additional Context
- **Labels**: - **Issue Type**:
- `test` - `Test`
### Build Task ### Build Task
- **Title**: `Build: <short description>` - **Title**: `<short description>`
- **Template Sections**: - **Template Sections**:
- Overview - Overview
- Current Build Configuration - Current Build Configuration
- Proposed Changes - Proposed Changes
- Reason for Change - Reason for Change
- Impact - Impact
- **Labels**: - **Issue Type**:
- `build` - `Build`
### CI Task ### CI Task
- **Title**: `CI: <short description>` - **Title**: `<short description>`
- **Template Sections**: - **Template Sections**:
- Overview - Overview
- Current CI Setup - Current CI Setup
- Proposed Changes - Proposed Changes
- Motivation - Motivation
- Impact - Impact
- **Labels**: - **Issue Type**:
- `ci` - `CI`
### Chore Task ### Chore Task
- **Title**: `Chore: <short description>` - **Title**: `<short description>`
- **Template Sections**: - **Template Sections**:
- Overview - Overview
- Task Details - Task Details
- Reasoning - Reasoning
- Impact - Impact
- **Labels**: - **Issue Type**:
- `chore` - `Task`
### Revert Task ### Revert Task
- **Title**: `Chore: <short description>` - **Title**: `Chore: <short description>`
@@ -194,8 +178,8 @@ When creating an issue, use the appropriate template:
- Commit/PR to Revert - Commit/PR to Revert
- Reason for Revert - Reason for Revert
- Impact - Impact
- **Labels**: - **Issue Type**:
- `chore` - `Revert`
## Referencing Issues and Pull Requests ## Referencing Issues and Pull Requests
- **Closing Issues Automatically**: Include keywords in pull requests to close issues automatically when merged - **Closing Issues Automatically**: Include keywords in pull requests to close issues automatically when merged
@@ -208,7 +192,7 @@ When creating an issue, use the appropriate template:
## Commenting Guidelines ## Commenting Guidelines
- Keep comments relevant and concise - Keep comments relevant and concise
- Update the issue with preogress reports if you're assigned - Update the issue with progress reports if you're assigned
## Workflow ## Workflow
1. **Search Before Posting**: Check if a similar issue already exists. 1. **Search Before Posting**: Check if a similar issue already exists.
@@ -225,8 +209,7 @@ When creating an issue, use the appropriate template:
Title: Title:
Feature: Implement note graph visualization Feature: Implement note graph visualization
Labels: Issue Type: Feature
- feature
Description: Description:
@@ -249,8 +232,7 @@ Helps users understand relationships between notes at a glance.
Title: Title:
Bug: Unable to save notes with special characters Bug: Unable to save notes with special characters
Labels: Issue Type: Bug
- bug
Description: Description: