Add Software Architecture, Design, Construction, and Testing Document… · GC-STEM/.github@b47caae · GitHub
Skip to content

Commit b47caae

Browse files
committed
Add Software Architecture, Design, Construction, and Testing Documentation
- Created Software Architecture Description (SAD) template in docs/19_architecture.md - Added Software Design Description (SDD) template in docs/20_design.md - Introduced diagram template for architecture and design in docs/23_diagram.drawio - Added pseudocode template for algorithm design in docs/26_pseudocode.txt - Created Software Construction Plan (SCP) template in docs/30_construction.md - Added Software Test Plan (STP) template in docs/40_testing.md
1 parent 32dd969 commit b47caae

22 files changed

Lines changed: 2520 additions & 268 deletions
Lines changed: 26 additions & 0 deletions

.github/ISSUE_TEMPLATE/report-a-problem.yml renamed to .github/ISSUE_TEMPLATE/.old/report-a-problem.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
name: Report a problem
22
description: Report something that did not work as expected.
33
title: "[Problem] "
4+
labels: ["Bug", "Needs Triage"]
45
body:
56
- type: dropdown
67
id: submitter

.github/ISSUE_TEMPLATE/report-accessibility-barrier.yml renamed to .github/ISSUE_TEMPLATE/.old/report-accessibility-barrier.yml

File renamed without changes.
File renamed without changes.

‎.github/ISSUE_TEMPLATE/README.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# GC-STEM Issue Templates
2+
3+
This folder contains issue templates for the GC-STEM repository ecosystem. Issue templates help standardize the information provided when creating new issues, making it easier for maintainers to triage and address them efficiently.
4+
5+
## Report an Accessibility Barrier
6+
7+
Use this template to report any accessibility barriers you encounter within the GC-STEM repository ecosystem. This helps maintainers identify and address accessibility issues effectively.
8+
9+
## Report a Bug
10+
11+
Use this template to report any bugs you encounter within the GC-STEM repository ecosystem. This helps maintainers identify and address issues effectively.
12+
13+
## Bibliography
14+
15+
- [About issue and pull request templates](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)
16+
- [Adding items automatically](https://docs.github.com/en/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically)
17+
- [Common validation errors when creating issue forms](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms)
18+
- [Configuring issue templates for your repository](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository)
19+
- [GitHub Issue Templates by Steve Mao](https://github.com/stevemao/github-issue-templates)
20+
- [Setting guidelines for repository contributors](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)
21+
- [Syntax for GitHub's form schema](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema)
22+
- [Syntax for issue forms](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms)
Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
name: ♿ Accessibility Barrier
2+
description: Report an issue that prevents users from fully accessing or interacting with the project.
3+
title: "[Barrier]: <title>"
4+
labels: ["accessibility", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for helping us make this project more inclusive! Please provide as much context as possible so we can reproduce and fix the barrier.
10+
11+
- type: dropdown
12+
id: submitter
13+
attributes:
14+
label: Submitter
15+
description: Who is submitting this report?
16+
options:
17+
- Student
18+
- Faculty
19+
- Advisor
20+
- Dean
21+
- OAC
22+
- Other staff
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: barrier-description
28+
attributes:
29+
label: Description of the Barrier
30+
description: What is the obstacle, and how does it impact the user experience?
31+
placeholder: E.g., The main navigation menu cannot be opened using only a keyboard...
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: reproduction-steps
37+
attributes:
38+
label: Steps to Reproduce
39+
description: Explain how a developer or tester can replicate this accessibility issue.
40+
placeholder: |
41+
1. Navigate to the homepage.
42+
2. Press 'Tab' until reaching the profile dropdown.
43+
3. Press 'Enter' or 'Space' to expand it.
44+
4. Observe that focus jumps to the bottom of the page instead of into the menu.
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: expected-behavior
50+
attributes:
51+
label: Expected & Accessible Behavior
52+
description: What should happen to ensure compliance and a good user experience?
53+
placeholder: E.g., When the dropdown expands, keyboard focus should trap inside the menu elements...
54+
validations:
55+
required: true
56+
57+
- type: input
58+
id: page-url
59+
attributes:
60+
label: Affected URL / Screen
61+
description: Where exactly does this issue occur?
62+
placeholder: e.g., https://example.com or "On the login modal"
63+
validations:
64+
required: true
65+
66+
- type: checkboxes
67+
id: assistive-tech
68+
attributes:
69+
label: Assistive Technology / Tools Used
70+
description: Select all tools involved in finding or verifying this issue.
71+
options:
72+
- label: Keyboard Navigation Only
73+
- label: Screen Reader (NVDA, JAWS, VoiceOver, TalkBack)
74+
- label: Screen Magnification / Zoom (e.g., 200%+, ZoomText)
75+
- label: Voice Control / Speech Recognition
76+
- label: Automated Testing Tool (Axe, Lighthouse, WAVE)
77+
- label: High Contrast Mode / Color Filters
78+
79+
- type: textarea
80+
id: environment
81+
attributes:
82+
label: Environment Details
83+
description: Please specify your Operating System, Browser, and Screen Reader if applicable.
84+
placeholder: e.g., Windows 11, Chrome v120, NVDA v2023.3
85+
validations:
86+
required: false
87+
88+
- type: dropdown
89+
id: wcag-impact
90+
attributes:
91+
label: WCAG Success Criteria / Impact (If known)
92+
description: If you know which WCAG guideline this relates to or how severely it blocks access, select it here.
93+
options:
94+
- ⚠️ Low (Annoyance / minor workaround available)
95+
- 🛑 Medium (Significant barrier / difficult workaround)
96+
- 🚨 High / Critical (Complete blocker / cannot complete the task)
97+
- ℹ️ WCAG 2.1 - 2.1.1 Keyboard (Level A)
98+
- ℹ️ WCAG 2.1 - 1.4.3 Contrast (Minimum) (Level AA)
99+
- ℹ️ WCAG 2.1 - 4.1.2 Name, Role, Value (Level A)
100+
- ℹ️ I don't know / Not sure
101+
102+
- type: textarea
103+
id: visual-evidence
104+
attributes:
105+
label: Screenshots or Video
106+
description: Drag and drop or paste any images, GIFs, or code snippets that illustrate the issue.
107+
placeholder: Paste images here...
108+
validations:
109+
required: false
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: 🐞 Bug
2+
description: File a bug/issue
3+
title: "[BUG] <title>"
4+
labels: ["Bug", "Needs Triage"]
5+
assignees: []
6+
projects: []
7+
type: bug
8+
body:
9+
- type: checkboxes
10+
attributes:
11+
label: Is there an existing issue for this?
12+
description: Please search to see if an issue already exists for the bug you encountered.
13+
options:
14+
- label: I have searched the existing issues
15+
required: true
16+
- type: textarea
17+
attributes:
18+
label: Current Behavior
19+
description: A concise description of what you're experiencing.
20+
validations:
21+
required: false
22+
- type: textarea
23+
attributes:
24+
label: Expected Behavior
25+
description: A concise description of what you expected to happen.
26+
validations:
27+
required: false
28+
- type: textarea
29+
attributes:
30+
label: Steps To Reproduce
31+
description: Steps to reproduce the behavior.
32+
placeholder: |
33+
1. In this environment...
34+
1. With this config...
35+
1. Run '...'
36+
1. See error...
37+
validations:
38+
required: false
39+
- type: textarea
40+
attributes:
41+
label: Environment
42+
description: |
43+
examples:
44+
- **OS**: Ubuntu 20.04
45+
- **Node**: 13.14.0
46+
- **npm**: 7.6.3
47+
value: |
48+
- OS:
49+
- Node:
50+
- npm:
51+
render: markdown
52+
validations:
53+
required: false
54+
- type: textarea
55+
attributes:
56+
label: Anything else?
57+
description: |
58+
Links? References? Anything that will give us more context about the issue you are encountering!
59+
60+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
61+
validations:
62+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Turn off blank issues: Always pair your templates with a config.yml that disables blank issues so users don't bypass your structured formats.
2+
3+
blank_issues_enabled: false
4+
5+
# Pre-assign metadata: Use your templates to automatically apply basic labels (bug, enhancement) to help keep your triage workflow automated.
6+
7+
# Control template order: If you want your bug report to always appear first, use alphanumeric naming conventions on your files (e.g., 01-bug-report.yml, 02-feature-request.yml).
8+
9+
contact_links:
10+
- name: 🙋 Academic Support
11+
url: https://myapps.microsoft.com/signin/00b02d3d-d1f9-40dc-b7e0-a4c4f512c5b4?tenantId=2baef15b-b8de-423f-9d8a-46f3686d8848
12+
about: For all academic support needs, please use the official Microsoft Apps portal for your institution.
13+
- name: 🏫 Your Brightspace Course
14+
url: https://learn.snhu.edu/d2l/home
15+
about: For all course General Questions, assignment guidance, grading inquiries, and instructor communication, please use the official course platform.
16+
- name: 🛠️ IT Service Desk
17+
url: https://snhu.service-now.com/sp
18+
about: For all technical issues related to the course platform, please contact the IT Service Desk.
19+
20+

‎.github/ISSUE_TEMPLATE/feature-request.yml‎

Whitespace-only changes.
Lines changed: 62 additions & 0 deletions

0 commit comments

Comments
 (0)