Skip to content

Expand contributing guide - #300

Draft
Flerpharos wants to merge 1 commit into
mainfrom
agent/expand-contributing-guide
Draft

Expand contributing guide#300
Flerpharos wants to merge 1 commit into
mainfrom
agent/expand-contributing-guide

Conversation

@Flerpharos

Copy link
Copy Markdown
Collaborator

Summary

  • expand the root CONTRIBUTING.md from the existing Sphinx contributor guide
  • document unit, integration, and full-suite test commands
  • add non-mutating Ruff checks and summarize the GitHub Actions quality gates
  • complete the project's typing conventions and Python 3.10 compatibility guidance

Why

The repository already had a concise contributor file, but the fuller development workflow lived primarily in the documentation site. Bringing those established instructions into the root guide makes GitHub's contributor entry point more complete and keeps the commands consistent with the existing docs and configuration.

Impact

Documentation only. Contributors get a more complete local setup and verification reference; runtime behavior is unchanged.

Validation

  • uv run pre-commit run --files CONTRIBUTING.md
  • git diff --check
  • verified documented hook IDs, workflow names, and example test path against the repository

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.

1 participant