Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (53 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

78 lines (53 loc) · 1.58 KB
Raw

Contributing to 01cloud-backup

Thanks for your interest in contributing.

Reporting bugs

Open a GitHub issue and include:

  • Clear description
  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Logs/screenshots when relevant
  • Environment details (OS, Go version, Kubernetes/Velero versions)

Suggesting features

Open a GitHub issue with:

  • Problem statement
  • Proposed solution
  • Alternatives considered
  • Impact and compatibility notes

Development setup

  1. Fork and clone this repository.

  2. Create local env file:

    cp .env.sample .env

  3. Install dependencies:

    go mod download

  4. Run checks:

    make format make lint make test-dev

  5. Run service:

    make run-dev

Branch naming convention

Use one of:

  • feat/<short-description>
  • fix/<short-description>
  • docs/<short-description>
  • refactor/<short-description>
  • test/<short-description>
  • chore/<short-description>

Pull request process

  1. Create branch from main.
  2. Keep PR scope small and focused.
  3. Add/adjust tests for behavior changes.
  4. Update docs when API/config changes.
  5. Ensure formatting, lint, and tests pass.
  6. Open PR using the PR template.
  7. Link issues (example: Closes #123).

Coding standards

  • Follow idiomatic Go and existing project structure.
  • Run gofmt on changed Go files.
  • Avoid hardcoded credentials/secrets/internal URLs.
  • Keep functions readable and maintainable.
  • Keep comments accurate and useful.
  • Follow Conventional Commits for commit messages.

Code of conduct

By participating, you agree to the CODE_OF_CONDUCT.md.