Skip to content

Conversation

@kolkov
Copy link
Contributor

@kolkov kolkov commented Dec 24, 2025

Summary

Comprehensive update to CONTRIBUTING.md reflecting current project maturity and practices.

Changes

Added

  • Table of Contents for easier navigation
  • Prerequisites table with golangci-lint
  • Detailed linting section (20+ linters, key requirements)
  • Branch naming conventions (feat/, fix/, docs/, etc.)
  • Branch Protection documentation
  • CI Pipeline description with all checks
  • Proper Code of Conduct section

Updated

  • Removed "Document in progress" status - project is mature
  • Updated Go version to 1.25+
  • Modernized formatting with tables
  • Updated Areas for Contribution with current priorities
  • License section now references Apache 2.0

Improved

  • Better code examples with doc comments ending in periods
  • Clearer PR process with checklist
  • More specific commit message examples

Test plan

  • Markdown renders correctly
  • All links valid
  • Consistent with actual project practices

Part of v0.7.2 documentation improvements.

- Removed 'Document in progress' status
- Added Table of Contents
- Updated prerequisites with golangci-lint
- Added detailed linting section (20+ linters)
- Added branch naming conventions
- Added Branch Protection documentation
- Added CI Pipeline description with all checks
- Updated Areas for Contribution with current priorities
- Added proper Code of Conduct section
- Updated license to Apache 2.0
- Modernized formatting with tables
@codecov
Copy link

codecov bot commented Dec 24, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@kolkov kolkov merged commit a837734 into main Dec 24, 2025
9 checks passed
@kolkov kolkov deleted the docs/contributing-update branch December 24, 2025 15: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.

2 participants