Skip to content

Commit

Permalink
Add issue template to repo
Browse files Browse the repository at this point in the history
  • Loading branch information
r00tmeister committed Aug 19, 2024
1 parent a1f18b1 commit ff0e191
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 2 deletions.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: "Architectural Documentation Issue"
about: "Template for creating an issue related to documenting the architecture of the project."
title: "[Architecture Docs] "
labels: documentation, architecture
assignees: ''

---

### Description
Provide a detailed description of the architectural documentation that needs to be created or updated. Specify the areas of the architecture that will be covered (e.g., system overview, component diagrams, data flow).

### Scope
Define the scope of the documentation. What specific aspects of the architecture are you focusing on? (e.g., high-level architecture, microservices, database schema, integration points).

### Tasks
- [ ] List the tasks required to complete the documentation.
- [ ] Include steps such as creating diagrams, writing descriptions, or defining interfaces.

### Acceptance Criteria
Clearly state the acceptance criteria to mark this issue as completed.
- [ ] Comprehensive description of the system architecture.
- [ ] Diagrams illustrating key components and their interactions.
- [ ] Explanation of key design decisions and trade-offs.

### Resources
List any resources or references, such as existing documentation, architectural diagrams, or relevant articles.

### Dependencies
Mention any dependencies, such as input from other team members, existing documentation, or specific tools.

### Additional Notes
Add any additional notes or references, such as related issues, project goals, or future considerations.

4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ hero:
text: View the wireframe
link: https://www.figma.com/proto/jHfYyjctrU6Ud5FIaAdJv4/Group-9-Low-Fidelity-Wireframe?node-id=0-1&t=QFNMCXKmwehyTaEW-1
- theme: alt
text: Arc42
text: Arc42 Architecture Methodlogy
link: https://arc42.org/overview
- theme: alt
text: C4 Modelling
text: C4 Modelling Architecture Diagram Methodology
link: https://c4model.com/

features:
Expand Down

0 comments on commit ff0e191

Please sign in to comment.