Merge pull request #22 from wirc-sjsu/develop-w21
[WRF-Fire-merge.git] / .github / ISSUE_TEMPLATE / docs-only.md
bloba759d24abcc952c9ccdb67ad92bda8e6ccecb558
1 ---
2 name: Documentation Request
3 about: Propose documentation for improvement
4 title: 'Refactor: [Brief Description]'
5 labels: refactoring
6 assignees: ''
8 ---
10 A brief summary of the documentation proposal.
12 ## Current Implementation
13 - Describe the current docs that needs refactoring.
14 - Mention specific files where applicable.
16 ## Proposed Changes
17 - Detailed description of the proposed changes.
18 - Explain how these changes will improve the documentation (e.g., readability, clarity).
20 ## Backward compatibility
21 *Does this change break backward compatibility?*
23 Yes/No
25 ## Additional Information
26 - Any other information, context, or justification for why this documentation change is beneficial or necessary.
27 - Links to relevant documentation, prior discussions, or related issues.