docs: Sync CONTRIBUTING.md with recent tooling changes.#404
Merged
Conversation
Bring the contributor guide in sync with changes landed since v0.16: - Add S110 to the active rules table (silent try/except:pass). - Add explicit preview rules section listing all 12 pycodestyle rules enabled in #400 and #402 (E203, E225, E231, E261, E262, E265, E275, E301, E302, E303, E305, W391). - Add B905 and ISC003 to the MicroPython exceptions table. - Add frozen manifest check to the CI table. - Mention both MicroPython and DAPLink firmwares in the release section. - Add line endings subsection explaining .gitattributes LF enforcement and the renormalize step for existing Windows + WSL clones. - Note that Pylance config now lives in pyproject.toml [tool.pyright].
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the contributor documentation to reflect the current repo tooling configuration (ruff, CI checks, releases, line ending normalization, and dev container/Pylance setup) since v0.16.
Changes:
- Documented the newly enabled ruff rule S110 and listed explicitly enabled pycodestyle preview rules.
- Expanded MicroPython-specific ruff ignores (B905, ISC003) and updated the CI checks table (incl. frozen manifest verification).
- Updated release docs to mention attaching both MicroPython and DAPLink firmwares, and added guidance on LF line-ending enforcement via
.gitattributes.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| * **zsh + oh-my-zsh** as default shell with persistent shell history | ||
| * **Pylance** configured with MicroPython STM32 stubs (no false `import machine` errors) | ||
| * **Pylance** configured with MicroPython STM32 stubs via `[tool.pyright]` in `pyproject.toml` (no false `import machine` errors) |
There was a problem hiding this comment.
This bullet says Pylance is configured via [tool.pyright] in pyproject.toml, but the repo also still contains a top-level pyrightconfig.json with overlapping settings. Since pyrightconfig.json is commonly picked up by Pyright/Pylance, this is ambiguous—please clarify which config file is authoritative (and whether pyrightconfig.json is legacy) to avoid contributors editing the wrong one.
Suggested change
| * **Pylance** configured with MicroPython STM32 stubs via `[tool.pyright]` in `pyproject.toml` (no false `import machine` errors) | |
| * **Pylance** configured with MicroPython STM32 stubs via `[tool.pyright]` in `pyproject.toml` (no false `import machine` errors). `pyproject.toml` is the authoritative Pyright/Pylance configuration; if a top-level `pyrightconfig.json` is present, treat it as legacy compatibility and update `pyproject.toml` instead. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Bring the contributor guide in sync with all tooling changes since v0.16.
Changes
zip(strict=)) and ISC003 (f-string implicit concat).gitattributesLF enforcement,git add --renormalize .step for Windows + WSL clonespyproject.toml[tool.pyright]Test plan
pyproject.toml