Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (36 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

50 lines (36 loc) · 1.47 KB
Raw

Contributing

Thank you for your interest in contributing. This repository is a Go project template, so changes should keep the generated-project path simple and predictable. For private vulnerability reporting, use SECURITY.md instead of public channels.

Reporting Bugs

Report non-security bugs through GitHub issues. Include the following details when possible:

  • version, commit, or environment details
  • steps to reproduce
  • expected behavior
  • actual behavior
  • logs, screenshots, or a minimal reproduction

If you are reporting a security issue, stop and follow SECURITY.md instead.

Pull Requests

Contributors should:

  1. Keep changes focused and scoped to a single problem.
  2. Add or update tests when behavior changes.
  3. Update documentation when user-facing behavior changes.
  4. Use Conventional Commit subjects, such as feat: add config loader or fix: handle empty input.
  5. Make sure moon run root:check passes before requesting review.

Local Setup

mise install         # provision the pinned toolchain (Go, Moon, the dev CLIs)
moon run root:check

Useful project commands:

moon run root:format
moon run root:lint
moon run root:build
moon run root:test
go run ./cmd/template-go --version

Release Changes

Release Please reads Conventional Commit subjects to build changelogs and release PRs. Keep release-impacting commits clear; routine docs, CI, and maintenance commits should use the appropriate non-release type.