Skip to content

Add pre-commit to CubedOS project.#66

Open
DavidMiserak wants to merge 4 commits intocubesatlab:v1branchfrom
DavidMiserak:pre-commit
Open

Add pre-commit to CubedOS project.#66
DavidMiserak wants to merge 4 commits intocubesatlab:v1branchfrom
DavidMiserak:pre-commit

Conversation

@DavidMiserak
Copy link
Contributor

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.md to guide contributors on development environment setup and repository standards.

Developer workflow enhancements:

  • Added .pre-commit-config.yaml to enable automated formatting, linting, and code quality checks using pre-commit hooks for Markdown, YAML, and general file hygiene.
  • Introduced .markdownlint.yaml to configure Markdown linting rules, disabling specific checks for flexibility in documentation formatting.

Documentation improvements:

  • Significantly expanded and clarified README.md to 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]
  • Improved section formatting and minor corrections in doc/README.md, including clearer headings and additional build instructions. [1] [2] [3]

Project consistency:

  • Added .codespellignore entries 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.

@DavidMiserak
Copy link
Contributor Author

DavidMiserak commented Sep 24, 2025

I often read Markdown files on the terminal via bat README.md[0]. I would like to use emacs word-wrap and include those changes as the last commit to this PR.

[0] https://github.com/sharkdp/bat

@pchapin
Copy link
Member

pchapin commented Oct 30, 2025

The CubeSat project at Vermont State University has ended. No further work on it is expected. No further pull requests will be accepted.

@pchapin pchapin closed this Oct 30, 2025
@pchapin
Copy link
Member

pchapin commented Nov 17, 2025

The CubeSat project will continue as an independent, open-source project in the same location. This PR is reopened for consideration.

@pchapin pchapin reopened this Nov 17, 2025
@pchapin
Copy link
Member

pchapin commented Nov 17, 2025

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 references folders. Also, there are modifications to JetBrains's project files in .idea folders. That seems inappropriate, too. LaTeX style files (that are produced outside of our control) should also not be touched (e.g., *.bst). Perhaps a better approach would be to apply the hook to a specific and possibly limited collection of whitelisted files, rather than globally with a few files excluded.

Can the general linting be limited to, say, *.md, *.txt, *.tex, *.ad{s,b} with exclusions for everything beneath references and .idea? That would produce a more focused effect and be less likely to modify something that shouldn't be altered.

Also, the project has traditionally supported line lengths of 96 characters. I notice this PR includes a lot of reflowing in README.md to narrower lines. I'm not opposed to adopting a new standard for line lengths, but I do feel that, for example, 80 characters is too narrow a limit.

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.

2 participants