Skip to content

Commit 2944029

Browse files
committed
Add initial project configuration and documentation
- Introduced .editorconfig for consistent coding styles across the project. - Added .eslintrc.cjs for linting rules and configurations. - Created .gitignore to exclude unnecessary files from version control. - Included .prettierrc for code formatting preferences. - Established CHANGELOG.md to document notable changes and updates. - Enhanced accessibility in index.html with ARIA roles and labels. - Implemented sound effects toggle and undo functionality in the game. - Updated README.md to reflect new features and improvements. - Added CI workflow for automated testing and linting on pull requests.
1 parent e85cbfd commit 2944029

31 files changed

Lines changed: 747 additions & 118 deletions

.editorconfig

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# EditorConfig helps maintain consistent coding styles
2+
root = true
3+
4+
[*]
5+
charset = utf-8
6+
end_of_line = lf
7+
insert_final_newline = true
8+
indent_style = space
9+
indent_size = 4
10+
trim_trailing_whitespace = true
11+

.eslintrc.cjs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
module.exports = {
2+
env: { browser: true, es2021: true, jest: true },
3+
extends: ["eslint:recommended", "plugin:prettier/recommended"],
4+
parserOptions: { ecmaVersion: "latest", sourceType: "module" },
5+
rules: {
6+
"no-unused-vars": ["warn", { argsIgnorePattern: "^_" }],
7+
"no-console": "off"
8+
}
9+
};
10+

.github/CODEOWNERS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* @TMHSDigital
2+

.github/CODE_OF_CONDUCT.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Code of Conduct
2+
3+
We are committed to a welcoming, inclusive, and respectful community.
4+
5+
- Be kind and constructive. Assume good intent.
6+
- No harassment, hate speech, or discrimination.
7+
- Keep feedback actionable and specific.
8+
9+
Report unacceptable behavior via a maintainer contact on GitHub. The maintainers may remove content or restrict participation to uphold this policy.

.github/CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Contributing
2+
3+
Thanks for your interest in contributing! This project is a static site (no build). Please:
4+
5+
1. Fork the repo and create a feature branch
6+
2. Keep changes focused and small
7+
3. Run lint and tests locally (`npm run lint && npm test`)
8+
4. Open a PR with a clear description and screenshots if UI changes
9+
10+
Guidelines:
11+
- Keep vanilla JS, HTML, CSS (no runtime frameworks)
12+
- Maintain accessibility (labels, keyboard, focus)
13+
- Preserve GitHub Pages deployment from repository root
14+
- Add tests for game logic changes
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
labels: bug
5+
---
6+
7+
### Describe the bug
8+
9+
### Steps to reproduce
10+
1.
11+
2.
12+
3.
13+
14+
### Expected behavior
15+
16+
### Screenshots or console logs
17+
18+
### Environment
19+
- Browser and version:
20+
- OS:
21+
22+
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
labels: enhancement
5+
---
6+
7+
### Problem to solve
8+
9+
### Proposed solution
10+
11+
### Alternatives considered
12+
13+
### Additional context
14+
15+

.github/SECURITY.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Security Policy
2+
3+
If you discover a security vulnerability, please responsibly disclose it by opening a security advisory or emailing the maintainer via GitHub profile contact. Do not open a public issue for sensitive reports.
4+
5+
We aim to respond within 7 days.
6+

.github/dependabot.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "npm"
4+
directory: "/"
5+
schedule:
6+
interval: "daily"
7+
- package-ecosystem: "github-actions"
8+
directory: "/"
9+
schedule:
10+
interval: "weekly"
11+

.github/pull_request_template.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Summary
2+
3+
Describe the change and its purpose.
4+
5+
## Checklist
6+
7+
- [ ] Tests added/updated
8+
- [ ] Lint passes locally (`npm run lint`)
9+
- [ ] No runtime changes to static hosting flow
10+
- [ ] Accessibility checked (labels, focus, keyboard)
11+
12+
## Screenshots/Notes
13+
14+

0 commit comments

Comments
 (0)