Skip to content

chore: add repo best practices (templates, linter config, editor config)#13

Merged
mlorentedev merged 3 commits intomasterfrom
chore/repo-best-practices
Mar 8, 2026
Merged

chore: add repo best practices (templates, linter config, editor config)#13
mlorentedev merged 3 commits intomasterfrom
chore/repo-best-practices

Conversation

@mlorentedev
Copy link
Owner

Summary

  • Add GitHub templates: PR template, YAML issue forms (bug report, feature request), SECURITY.md
  • Add .golangci.yml to pin linter configuration (15 linters enabled)
  • Add .editorconfig for cross-editor consistency
  • Add project-level CLAUDE.md with tech stack, key paths, and conventions
  • Fix stale Go version in CONTRIBUTING.md (1.21+ → 1.25+)

Changes

  • .github/pull_request_template.md: PR checklist template
  • .github/ISSUE_TEMPLATE/bug_report.yml: Structured bug report form
  • .github/ISSUE_TEMPLATE/feature_request.yml: Feature request form
  • .github/ISSUE_TEMPLATE/config.yml: Disable blank issues, link to docs
  • SECURITY.md: Vulnerability reporting process
  • CLAUDE.md: Project instructions for Claude Code
  • .golangci.yml: Pinned linter config (gocyclo, gosec, misspell, etc.)
  • .editorconfig: Tabs for Go, spaces for YAML/MD, CRLF for PS1
  • CONTRIBUTING.md: Go 1.21+ → 1.25+
  • .gitignore: Unignore CLAUDE.md

Testing

  • go test -race ./... passes (no code changes)
  • go vet ./... clean
  • go build ./... clean

Type

  • chore — Maintenance

BP-002 through BP-006 from the Best Practices Equalization backlog.

- Add PR template and YAML issue forms (bug report, feature request)
- Add SECURITY.md with vulnerability reporting process
- Add CLAUDE.md with project-level instructions for Claude Code
- Add .golangci.yml to pin linter configuration
- Add .editorconfig for cross-editor consistency
- Fix stale Go version in CONTRIBUTING.md (1.21+ → 1.25+)
- Unignore CLAUDE.md from .gitignore (project instructions should be tracked)
- Replace hardcoded "127.0.0.1:33389" with defaultLocalAddr constant in tests
- Exclude test files from gocyclo (table-driven tests are legitimately complex)
- Suppress unparam for acceptLoop (returns nil by design on clean shutdown)
@mlorentedev mlorentedev merged commit 1c343c0 into master Mar 8, 2026
11 checks passed
@mlorentedev mlorentedev deleted the chore/repo-best-practices branch March 8, 2026 02:21
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