Skip to content

Conversation

@kazurem
Copy link
Collaborator

@kazurem kazurem commented Jan 2, 2026

You can see the changes and additions in CHANGELOG.md

kazurem and others added 27 commits December 9, 2025 20:53
Add common file types to .gitignore to prevent tracking.
Creating basic project file structure based on CMake
Adding testing functionality using GoogleTest
Added:
1. Table of Contents
2. Build Instructions for the project
3. Troubleshooting guide
4. Link to helpful resources
Added a comprehensive contributions guide for the MicroMouse Simulator project, covering prerequisites, development workflow, coding standards, and submission guidelines.
…ks, initialized CHANGELOG and added commitizen

clang-format:   tab-width, better alignment, some QoL.
clang-tidy:     added linting checks and enforced naming scheme
gitignore:      ignored more files
markdownlint:   changed default line lenght to 100
CHANGELOG:      based on keepachangelog.com and semver.org v2.0
commitizen:     better commit messages, the easy way
pre-commit:     the main purpose of this commit, explained below:

## pre-commit:
enable-testing: Enable the testing configuration of cmake
build:          build/compile the project, needed for testing
test:           run the google-tests on the project automatically
clang-format:   check whether code complies with the formatting standards
clang-tidy:     provides framework for diagnosing and fixing errors
cppcheck:       provides code analysis to detect bugs, undefined behaviour, etc.
typos:          check for typos with minimum false-positive results
commitizen:     better commit messages, the automated way
actionlint:     lint GitHub actions for common CI/CD bugs and errors
markdownlint:   lint markdown files to comply with repo standards
pre-commit:     miscellaneous minor checks for trivial mistakes
ci(pre-commit-config): Added pre-commit-hooks and CHANGELOG
…tions and additions in the latest merged pull request
- Move Doxyfile to sphinx_docs/ and update documentation workflow
- Update README.md and CONTRIBUTING.md with Sphinx instructions
- Fix font loading by adding assets/fonts and updating CMake/UI.cpp
- Apply clang-tidy fixes and modern C++ improvements
- Add error handling to Main.cpp
- Update .gitignore to exclude build artifacts
- Increase pre-commit file size limit for assets
- Resolve all cppcheck warnings with appropriate suppressions
- Apply clang-format
- Update tests to reflect changes
- All pre-commit hooks passing
@kazurem kazurem merged commit fb2b1f5 into main Jan 2, 2026
@kazurem kazurem deleted the dev branch January 2, 2026 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants