Skip to content

docs(contributing): add project contribution guide - #273

Merged
ZouR-Ma merged 1 commit into
mainfrom
docs/contribution-guide
Oct 20, 2026
Merged

ZouR-Ma merged 1 commit into
mainfrom
docs/contribution-guide

Conversation

@ZouR-Ma

@ZouR-Ma ZouR-Ma commented Oct 20, 2026

Copy link
Copy Markdown
Collaborator

Problem

Contributors need a clear project-wide guide to coordinating work, implementing changes, and submitting them for internal review.

Changes

  • Add contribute.md as an English contribution guide for the entire project.
  • Cover issue ownership, development preparation, focused commits, validation, collaborator access, and internal review and merge requirements.
  • Link the repository's authoritative contribution rules, development and testing guides, security policy, and PR template.
  • Use maintainer coordination and GitHub Issues for community-reported problems.

Behavior and compatibility

Documentation only; no runtime behavior or public interfaces change. CONTRIBUTING.md remains authoritative. Repository access policy is distinguished from actual settings that maintainers must verify.

Validation

On macOS with Node.js v24.3.0 and pnpm 9.15.9:

  • npm run check: passed, with no tracked formatter changes.
  • TMPDIR=/tmp ./test.sh: passed across the repository. A short temporary path avoids the macOS tsx IPC socket path-length limitation encountered in the previous version.
  • Python checks of relative Markdown links and English project-wide wording: passed.
  • git diff --cached --check: passed.

Limitations

GitHub CI and internal maintainer approval are pending. Repository permission and branch protection settings were not audited.

Replaces #272 using the renamed contribution-guide branch.

@ZouR-Ma
ZouR-Ma merged commit e08c6dd into main Oct 20, 2026
2 checks passed
@ZouR-Ma
ZouR-Ma deleted the docs/contribution-guide branch October 20, 2026 09:14
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