117 lines
3.4 KiB
YAML
117 lines
3.4 KiB
YAML
name: Documentation
|
|
description: Improvements or additions to documentation
|
|
title: "[DOC] "
|
|
labels: ["documentation"]
|
|
assignees:
|
|
- ${{github.actor}}
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Use this template for documentation-related tasks for your thesis project.
|
|
|
|
- type: dropdown
|
|
id: doc_type
|
|
attributes:
|
|
label: Documentation Type
|
|
description: What type of documentation is this issue about?
|
|
options:
|
|
- Thesis Chapter/Section
|
|
- Code Documentation
|
|
- Experiment Documentation
|
|
- README/Project Documentation
|
|
- Literature Review
|
|
- Methodology Description
|
|
- Results Analysis
|
|
- API Reference
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: description
|
|
attributes:
|
|
label: Description
|
|
description: Describe what needs to be documented
|
|
placeholder: Need to document the data preprocessing pipeline including all transformation steps and rationale
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: current_state
|
|
attributes:
|
|
label: Current State
|
|
description: What's the current state of the documentation (if any)?
|
|
placeholder: Currently there are some comments in the code but no comprehensive documentation of the preprocessing steps
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: proposed_changes
|
|
attributes:
|
|
label: Proposed Changes
|
|
description: What specific documentation changes do you want to make?
|
|
placeholder: |
|
|
1. Create a dedicated markdown file describing each preprocessing step
|
|
2. Add docstrings to all preprocessing functions
|
|
3. Create a diagram showing the data flow
|
|
4. Document parameter choices and their justification
|
|
validations:
|
|
required: true
|
|
|
|
- type: input
|
|
id: location
|
|
attributes:
|
|
label: Documentation Location
|
|
description: Where will this documentation be stored?
|
|
placeholder: docs/data_preprocessing.md or src/preprocessing/README.md
|
|
validations:
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: priority
|
|
attributes:
|
|
label: Priority
|
|
description: How important is this documentation?
|
|
options:
|
|
- Critical (required for thesis)
|
|
- High (important for understanding)
|
|
- Medium (helpful but not urgent)
|
|
- Low (nice to have)
|
|
validations:
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: audience
|
|
attributes:
|
|
label: Target Audience
|
|
description: Who is the primary audience for this documentation?
|
|
options:
|
|
- Thesis Committee/Reviewers
|
|
- Future Self
|
|
- Other Researchers
|
|
- Technical Readers
|
|
- Non-technical Readers
|
|
- Multiple Audiences
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: references
|
|
attributes:
|
|
label: References
|
|
description: Any papers, documentation or other materials related to this documentation task
|
|
placeholder: |
|
|
- Smith et al. (2022). "Best practices in machine learning documentation"
|
|
- Code in src/preprocessing/normalize.py
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: notes
|
|
attributes:
|
|
label: Additional Notes
|
|
description: Any other relevant information
|
|
placeholder: This documentation will be referenced in Chapter 3 of the thesis
|
|
validations:
|
|
required: false
|