Skip to content

Commit a66b031

Browse files
committed
chore: lint & update Markdown templates
1 parent 829b1b7 commit a66b031

4 files changed

Lines changed: 49 additions & 9 deletions

File tree

.github/BRANCH_PROTECTION.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,42 +9,51 @@ This document outlines the recommended branch protection rules and GitHub Action
99
### Recommended Settings:
1010

1111
#### 1. Require Pull Request Reviews
12+
1213
- **Require approvals**: 1 approval minimum
1314
- **Dismiss stale reviews**: Yes (when new commits are pushed)
1415
- **Require review from Code Owners**: Optional (if CODEOWNERS is used)
1516

1617
#### 2. Require Status Checks to Pass
18+
1719
**Enable**: Require status checks to pass before merging
1820

1921
**Required status checks** (all must pass):
22+
2023
- `Lint filter list files` (from lint-filters.yml)
2124
- `Lint JSON files` (from lint-json.yml)
2225
- `Lint Markdown files` (from lint-markdown.yml)
2326
- `Lint YAML files` (from lint-yaml.yml)
2427

2528
**Additional settings**:
29+
2630
- ✅ Require branches to be up to date before merging
2731
- ✅ Do NOT require approval to run workflows on PRs from contributors
2832
- This allows checks to run automatically without maintainer approval
2933
- Workflows already have minimal permissions (`contents: read`)
3034
- No write access or secrets are exposed
3135

3236
#### 3. Require Conversation Resolution
37+
3338
- **Enabled**: Require all conversations to be resolved before merging
3439

3540
#### 4. Require Signed Commits (Optional but Recommended)
41+
3642
- **Enabled**: Require commits to be signed
3743
- Enhances security by verifying commit authenticity
3844

3945
#### 5. Require Linear History
46+
4047
- **Enabled**: Prevent merge commits
4148
- Keeps history clean with rebase/squash merges
4249

4350
#### 6. Include Administrators
51+
4452
- **Enabled**: Apply rules to administrators
4553
- Ensures consistency and prevents accidental bypasses
4654

4755
#### 7. Restrict Pushes
56+
4857
- **Allow force pushes**: No
4958
- **Allow deletions**: No
5059

@@ -64,13 +73,15 @@ All workflows already implement security best practices:
6473
### Why `pull_request` is Safe
6574

6675
The workflows use `pull_request` trigger which:
76+
6777
- ✅ Runs in the context of the PR branch (not main)
6878
- ✅ Does not have access to repository secrets
6979
- ✅ Only has `contents: read` permission
7080
- ✅ Cannot modify the repository
7181
- ✅ Safe to run without approval for external contributors
7282

7383
Using `pull_request` instead of `pull_request_target` means:
84+
7485
- Checks run automatically on all PRs
7586
- No maintainer approval needed to run checks
7687
- Malicious PRs cannot access secrets or write to the repo
@@ -117,6 +128,7 @@ Current configuration in `.github/dependabot.yml`:
117128
### Step 2: Verify Workflow Security
118129

119130
All workflows already have proper security:
131+
120132
- ✅ Minimal permissions set
121133
- ✅ Using `pull_request` trigger (safe for external contributors)
122134
- ✅ No secrets exposed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,37 +7,52 @@ assignees: ''
77
---
88

99
## Bug Description
10+
1011
<!-- A clear and concise description of what the bug is -->
1112

1213
## Steps to Reproduce
13-
1. Go to '...'
14-
2. Click on '...'
15-
3. Scroll down to '...'
16-
4. See error
14+
15+
1. Launch lesson or course…
16+
2. Take quiz… or Progress through lesson…
17+
3. Submit item/score/completion
18+
4. See warning/error… or View results/report in system…
1719

1820
## Expected Behavior
21+
1922
<!-- A clear and concise description of what you expected to happen -->
2023

2124
## Actual Behavior
25+
2226
<!-- What actually happened -->
2327

2428
## Screenshots
29+
2530
<!-- If applicable, add screenshots to help explain your problem -->
2631

2732
## Environment
33+
2834
<!-- Please complete the following information -->
35+
2936
- **Browser:** [e.g., Chrome, Firefox, Safari]
3037
- **Browser Version:** [e.g., 120. 0.6099.109]
31-
- **Operating System:** [e. g., macOS 14.2, Windows 11, Ubuntu 22.04]
32-
- **Extension Version:** [e.g., 1.0.0]
38+
- **Operating System:** [e. g., iOS 26, macOS 26, Windows 11, Ubuntu 22.04]
39+
- **Content Authoring Tool:** [e. g., Adobe Captivate, Articulate Storyline, Lectora, etc]
40+
- **LMS/LRS:** [e. g., Cornerstone OnDemand, Docebo, SAP SuccessFactors, etc]
3341

3442
## Filter Lists Used
43+
3544
<!-- Which filter lists are you using? -->
36-
- [ ] moat-lms-blocker default filters
37-
- [ ] Custom filters (please describe)
45+
46+
- [ ] SCORM 1.2
47+
- [ ] SCORM 2004
48+
- [ ] xAPI
49+
- [ ] cmi5
50+
- [ ] AICC
3851

3952
## Additional Context
53+
4054
<!-- Add any other context about the problem here -->
4155

4256
## Possible Solution
57+
4358
<!-- Optional: Suggest a fix or reason for the bug -->

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,21 @@ assignees: ''
77
---
88

99
## Feature Description
10+
1011
<!-- A clear and concise description of the feature you'd like -->
1112

1213
## Problem it Solves
14+
1315
<!-- Describe the problem this feature would solve -->
1416

1517
## Proposed Solution
18+
1619
<!-- Describe how you envision this feature working -->
1720

1821
## Alternatives Considered
22+
1923
<!-- Describe any alternative solutions or features you've considered -->
2024

2125
## Additional Context
22-
<!-- Add any other context, mockups, or examples about the feature request
26+
27+
<!-- Add any other context, mockups, or examples about the feature request, or tools or systems it works with -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
## Description
2+
23
<!-- Provide a brief description of the changes in this PR -->
34

45
## Type of Change
6+
57
<!-- Mark the relevant option with an "x" -->
68

79
- [ ] Bug fix (non-breaking change which fixes an issue)
@@ -13,24 +15,28 @@
1315
- [ ] Test update
1416

1517
## Related Issues
18+
1619
<!-- Link to related issues using #issue_number -->
1720
Closes #
1821

1922
## Changes Made
23+
2024
<!-- List the specific changes made in this PR -->
2125

2226
-
2327
-
2428
-
2529

2630
## Testing
31+
2732
<!-- Describe the testing you've done -->
2833

2934
- [ ] I have tested these changes locally
3035
- [ ] All existing tests pass
3136
- [ ] I have added tests for new functionality
3237

3338
## Checklist
39+
3440
<!-- Mark completed items with an "x" -->
3541

3642
- [ ] My code follows the project's style guidelines
@@ -41,7 +47,9 @@ Closes #
4147
- [ ] I have checked my code and corrected any misspellings
4248

4349
## Screenshots (if applicable)
50+
4451
<!-- Add screenshots to help explain your changes -->
4552

4653
## Additional Notes
54+
4755
<!-- Any additional information that reviewers should know -->

0 commit comments

Comments
 (0)