samber/cc-skills-golang / skills/golang-documentation
golang-documentation
VerifiedComprehensive documentation guide for Golang projects, covering godoc comments, README, CONTRIBUTING, CHANGELOG, Go Playground, Example tests, API docs, and llms.txt. Use when writing or reviewing doc comments, documentation, adding code examples, setting up doc sites, or discussing documentation best practices. Triggers for both libraries and applications/CLIs.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 13.7 KB |
| assets/templates/CHANGELOG.md | markdown | 675 B |
| assets/templates/CONTRIBUTING.md | markdown | 1.1 KB |
| assets/templates/README.md | markdown | 3.8 KB |
| assets/templates/llms.txt | markdown | 1.2 KB |
| evals/evals.json | config | 31.2 KB |
| references/application.md | markdown | 5.8 KB |
| references/code-comments.md | markdown | 12.0 KB |
| references/library.md | markdown | 7.3 KB |
| references/project-docs.md | markdown | 4.3 KB |
assets/templates/CONTRIBUTING.md
View on GitHub# Contributing to {project-name}
Thank you for your interest in contributing!
## Prerequisites
- Go {version} or later
- Make (optional but recommended)
- Docker (for integration tests only)
## Quick Start
```bash
# Clone the repository
git clone https://github.com/{owner}/{repo}.git
cd {repo}
# Build
go build -o myapp ./cmd/main.go
# Run unit tests
go test -race ./...
# Run integration tests
go test -race -tags=integration -timeout=300s ./...
# Run linter
golangci-lint run --fix ./...
```
## Development Workflow
1. Fork the repository
2. Create a feature branch: `git checkout -b feat/my-feature`
3. Make your changes
4. Add tests for new functionality
5. Run `go test ./...` and `golangci-lint run`
6. Commit with a descriptive message
7. Push and open a Pull Request
## Code Guidelines
- Follow [Effective Go](https://go.dev/doc/effective_go)
- Add doc comments to all exported symbols
- Write table-driven tests
- Keep test coverage above {X}%
## Reporting Issues
Use [GitHub Issues](https://github.com/{owner}/{repo}/issues). Include:
- Go version (`go version`)
- OS and architecture
- Steps to reproduce
- Expected vs actual behavior
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| finishing-a-development-branchobra/superpowersUse when implementation is complete, all tests pass, and you need to decide how to integrate the work | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixes | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation code | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| skill-creatoranthropics/skillsCreate new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |