Skip to content

docs: Add comprehensive contribution guidelines#4

Open
chrobson wants to merge 1 commit intoctx42:masterfrom
chrobson:docs/add-contributing-guidelines
Open

docs: Add comprehensive contribution guidelines#4
chrobson wants to merge 1 commit intoctx42:masterfrom
chrobson:docs/add-contributing-guidelines

Conversation

@chrobson
Copy link
Copy Markdown

@chrobson chrobson commented Jul 8, 2025

Summary

  • Add detailed CONTRIBUTING.md with comprehensive guidelines for contributors
  • Covers development setup, code standards, testing patterns, and documentation requirements
  • Tailored to the project's unique architecture and self-testing patterns

Changes

  • CONTRIBUTING.md: New comprehensive contribution guide including:
    • Development setup and prerequisites (Go 1.24+, zero dependencies)
    • Code standards (4-space indentation, 80-char line length, SPDX headers)
    • Project structure explanation (pkg/ and internal/ organization)
    • Testing guidelines with self-testing patterns using tester package
    • Documentation standards for packages and inline code
    • Pull request process and commit message format
    • Release management workflow
    • Design principles (zero dependencies, modular design, fluent APIs)

Test plan

  • Verify file formatting and structure
  • Check all links and references are accurate
  • Review code examples for correctness
  • Ensure guidelines match existing project patterns

The guidelines are now ready for review and can be proposed to the project maintainers.

Add detailed CONTRIBUTING.md with:
- Development setup and prerequisites
- Code standards and formatting rules
- Project structure explanation
- Testing guidelines with self-testing patterns
- Documentation standards
- Pull request process and commit message format
- Release management workflow
- Design principles (zero dependencies, modular design)

The guide is tailored to the project's unique architecture including
the self-testing pattern for test helpers and golden file testing.
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