Add pre-commit to CubedOS project.#66
Add pre-commit to CubedOS project.#66DavidMiserak wants to merge 4 commits intocubesatlab:v1branchfrom
Conversation
|
I often read Markdown files on the terminal via |
|
The CubeSat project at Vermont State University has ended. No further work on it is expected. No further pull requests will be accepted. |
|
The CubeSat project will continue as an independent, open-source project in the same location. This PR is reopened for consideration. |
|
I like the concept of this PR, but it seems too aggressive. It involves manipulating the RFC documents, which are standard and shouldn't be modified (one could argue that they shouldn't be in the repository at all). In general, the modifications should avoid anything in the Can the general linting be limited to, say, Also, the project has traditionally supported line lengths of 96 characters. I notice this PR includes a lot of reflowing in |
This pull request introduces several improvements focused on documentation quality, developer workflow, and project consistency. The most significant changes include the addition of pre-commit hook configuration, Markdown linting settings, and expanded instructions in the main
README.mdto guide contributors on development environment setup and repository standards.Developer workflow enhancements:
.pre-commit-config.yamlto enable automated formatting, linting, and code quality checks using pre-commit hooks for Markdown, YAML, and general file hygiene..markdownlint.yamlto configure Markdown linting rules, disabling specific checks for flexibility in documentation formatting.Documentation improvements:
README.mdto include details on supported development environments, build/test instructions, sample projects, and explicit setup steps for pre-commit hooks and Visual Studio Code. [1] [2]doc/README.md, including clearer headings and additional build instructions. [1] [2] [3]Project consistency:
.codespellignoreentries for project-specific terms to reduce false positives in spell checking.Other minor changes include small formatting and spelling corrections in documentation and source files.