docs: improve Code Style section with actionable guidance#4458
Open
findmail wants to merge 1 commit into
Open
Conversation
Issue: rysweet#4421 Problem: - 'Follow existing code conventions' was circular guidance - No mention of the formatter (ruff) - No specific commands for contributors - Unclear for new contributors Solution: - Added explicit Ruff formatter instructions - Provided specific commands for formatting and linting - Added pre-commit setup and troubleshooting - Included markdownlint guidance - Added 'Getting Help' section This gives new contributors clear, actionable steps instead of vague directives. Co-authored-by: OpenClaw AI <noreply@openclaw.ai>
This was referenced Apr 23, 2026
This was referenced Apr 24, 2026
Closed
This was referenced Apr 29, 2026
This was referenced May 7, 2026
This was referenced May 15, 2026
This was referenced May 22, 2026
This was referenced May 29, 2026
This was referenced Jun 5, 2026
This was referenced Jun 15, 2026
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
Fixes #4421
Problem
The Code Style section told contributors to "follow existing code conventions" without explaining:
This circular guidance was unhelpful for new contributors.
Solution
Added Explicit Tool Information
Provided Actionable Commands
Added Pre-commit Guidance
Added Troubleshooting
Impact
New contributors now have:
Testing
pyproject.tomlFixes #4421