forked from hinterland/documentation
docs: majore update, including new github features
This commit is contained in:
@@ -3,32 +3,18 @@
|
||||
## Issue Title Conventions
|
||||
Issue titles should follow the format:
|
||||
```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>`
|
||||
- Use imperative, present tense: "Add", "Fix", "Improve"
|
||||
- Keep it concise and descriptive
|
||||
- Do not end with a period (`.`)
|
||||
|
||||
### Examples:
|
||||
- `Feature: Add note preview functionality`
|
||||
- `Bug: Fix crash when opening empty note`
|
||||
- `Refactor: Restructure configuration module`
|
||||
- `Add note preview functionality`
|
||||
- `Fix crash when opening empty note`
|
||||
- `Restructure configuration module`
|
||||
|
||||
## Issue Description Conventions
|
||||
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.
|
||||
```
|
||||
|
||||
## Labels
|
||||
Apply appropriate labels to categorize and prioritize issues.
|
||||
## Issue Type
|
||||
Apply appropriate issue type to categorize issues.
|
||||
|
||||
### Common Labels:
|
||||
|
||||
- ### Type:
|
||||
- `feature`
|
||||
- `bug`
|
||||
- `refactor`
|
||||
- `documentation`
|
||||
- `performance`
|
||||
- `test`
|
||||
- `build`
|
||||
- `ci`
|
||||
- `chore`
|
||||
- `revert`
|
||||
### 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
|
||||
|
||||
## Milestones
|
||||
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:
|
||||
|
||||
### Bug Report
|
||||
- **Title**: `Bug: <short description>`
|
||||
- **Title**: `<short description>`
|
||||
- **Template Sections**:
|
||||
- Overview
|
||||
- Steps to Reproduce
|
||||
@@ -100,92 +84,92 @@ When creating an issue, use the appropriate template:
|
||||
- Actual Behavior
|
||||
- Screenshots (if applicable)
|
||||
- Environment (OS, software vesions if possible)
|
||||
- **Labels**:
|
||||
- `bug`
|
||||
- **Issue Type**:
|
||||
- `Bug`
|
||||
|
||||
### Feature Request
|
||||
- **Title*: `Feature: <short description>`
|
||||
- **Title*: `<short description>`
|
||||
- **Template Sections**:
|
||||
- Overview
|
||||
- Motivation
|
||||
- Proposed Solution
|
||||
- Alternatives Considered
|
||||
- Additional Context
|
||||
- **Labels**:
|
||||
- `feature`
|
||||
- **Issue Type**:
|
||||
- `Feature`
|
||||
|
||||
### Refactor Task
|
||||
- **Title**: `Refactor: <short description>`
|
||||
- **Title**: `<short description>`
|
||||
- **Template Sections**:
|
||||
- Overview
|
||||
- Reason for Refactoring
|
||||
- Areas of Impact
|
||||
- Expected Benefits
|
||||
- **Labels**:
|
||||
- `refactor`
|
||||
- **Issue Type**:
|
||||
- `Refactor`
|
||||
|
||||
### Documentation Task
|
||||
- **Title**: `Documentation: <short description>`
|
||||
- **Title**: `<short description>`
|
||||
- **Template Sections**:
|
||||
- Overview
|
||||
- Pages or Sections Affected
|
||||
- Proposed Changes
|
||||
- **Labels**:
|
||||
- `documentation`
|
||||
- **Issue Type**:
|
||||
- `Documentation`
|
||||
|
||||
### Performance Improvement
|
||||
- **Title**: `Performance: <short description>`
|
||||
- **Title**: `<short description>`
|
||||
- **Template Sections**:
|
||||
- Overview
|
||||
- Current Performance
|
||||
- Expected Performance
|
||||
- Impact
|
||||
- Additional Information
|
||||
- **Labels**:
|
||||
- `performance`
|
||||
- **Issue Type**:
|
||||
- `Performance`
|
||||
|
||||
### Test Task
|
||||
- **Title**: `Test: <short description>`
|
||||
- **Title**: `<short description>`
|
||||
- **Template Sections**:
|
||||
- Overview
|
||||
- Areas to Test
|
||||
- Test Type
|
||||
- Motivation
|
||||
- Additional Context
|
||||
- **Labels**:
|
||||
- `test`
|
||||
- **Issue Type**:
|
||||
- `Test`
|
||||
|
||||
### Build Task
|
||||
- **Title**: `Build: <short description>`
|
||||
- **Title**: `<short description>`
|
||||
- **Template Sections**:
|
||||
- Overview
|
||||
- Current Build Configuration
|
||||
- Proposed Changes
|
||||
- Reason for Change
|
||||
- Impact
|
||||
- **Labels**:
|
||||
- `build`
|
||||
- **Issue Type**:
|
||||
- `Build`
|
||||
|
||||
### CI Task
|
||||
- **Title**: `CI: <short description>`
|
||||
- **Title**: `<short description>`
|
||||
- **Template Sections**:
|
||||
- Overview
|
||||
- Current CI Setup
|
||||
- Proposed Changes
|
||||
- Motivation
|
||||
- Impact
|
||||
- **Labels**:
|
||||
- `ci`
|
||||
- **Issue Type**:
|
||||
- `CI`
|
||||
|
||||
### Chore Task
|
||||
- **Title**: `Chore: <short description>`
|
||||
- **Title**: `<short description>`
|
||||
- **Template Sections**:
|
||||
- Overview
|
||||
- Task Details
|
||||
- Reasoning
|
||||
- Impact
|
||||
- **Labels**:
|
||||
- `chore`
|
||||
- **Issue Type**:
|
||||
- `Task`
|
||||
|
||||
### Revert Task
|
||||
- **Title**: `Chore: <short description>`
|
||||
@@ -194,8 +178,8 @@ When creating an issue, use the appropriate template:
|
||||
- Commit/PR to Revert
|
||||
- Reason for Revert
|
||||
- Impact
|
||||
- **Labels**:
|
||||
- `chore`
|
||||
- **Issue Type**:
|
||||
- `Revert`
|
||||
|
||||
## Referencing Issues and Pull Requests
|
||||
- **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
|
||||
- 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
|
||||
1. **Search Before Posting**: Check if a similar issue already exists.
|
||||
@@ -225,8 +209,7 @@ When creating an issue, use the appropriate template:
|
||||
Title:
|
||||
Feature: Implement note graph visualization
|
||||
|
||||
Labels:
|
||||
- feature
|
||||
Issue Type: Feature
|
||||
|
||||
Description:
|
||||
|
||||
@@ -249,8 +232,7 @@ Helps users understand relationships between notes at a glance.
|
||||
Title:
|
||||
Bug: Unable to save notes with special characters
|
||||
|
||||
Labels:
|
||||
- bug
|
||||
Issue Type: Bug
|
||||
|
||||
Description:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user