Skip to content

docs: move docs/development.md to CONTRIBUTING.md#16

Merged
kexi merged 1 commit into
mainfrom
docs/contributing-md
Jun 7, 2026
Merged

docs: move docs/development.md to CONTRIBUTING.md#16
kexi merged 1 commit into
mainfrom
docs/contributing-md

Conversation

@kexi

@kexi kexi commented Jun 7, 2026

Copy link
Copy Markdown
Owner

Summary

  • CONTRIBUTING.md at the repo root is the conventional home for contributor docs, and GitHub surfaces it automatically (it links to it on PR/issue creation), so it is more discoverable than docs/development.md.
  • Rename docs/development.mdCONTRIBUTING.md, fix its relative links (now root-relative, ../ stripped), retitle it "Contributing to pitty", and repoint the README's two references.

Test plan

  • CONTRIBUTING.md internal links resolve from repo root
  • README no longer references docs/development.md
  • cargo test + fmt clean (docs-only)

CONTRIBUTING.md at the repo root is the conventional home for contributor docs
and GitHub surfaces it automatically (PR/issue creation links to it), so it is
more discoverable than docs/development.md. Rename the file, fix its now-root
relative links, retitle it "Contributing to pitty", and repoint the README.

Co-Authored-By: Claude <noreply@anthropic.com>
@kexi kexi merged commit 7ad68b7 into main Jun 7, 2026
10 checks passed
@kexi kexi deleted the docs/contributing-md branch June 7, 2026 08:36
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