Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (56 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

76 lines (56 loc) · 2.68 KB
Raw

Contributing to nova (Nudgebee fork)

Thanks for considering a contribution. This repository is a Nudgebee-maintained fork of FairwindsOps/nova. Please read the README and NOTICE for the relationship to upstream and the trademark disclaimer.

Where to file what

  • Bugs or features that exist upstream: prefer FairwindsOps/nova. Fixes that land upstream get pulled in here on the next sync.
  • Bugs or features specific to this fork: file in this repository's issues. Use the bug / feature-request templates under .github/ISSUE_TEMPLATE/.
  • Security vulnerabilities: see SECURITY.md. Do not open a public issue for security reports.

Branch model

Single-branch: main is the only long-lived branch. Releases are cut as semver-tagged commits on main (e.g. v0.1.0).

  • All work targets main through a pull request.
  • Direct pushes to main are not accepted.
  • A release is a v<major>.<minor>.<patch> git tag pushed against a commit on main. The image-build workflow publishes the corresponding ghcr.io/nudgebee/nova:v<version> image on tag push.

Local development

Requires Go 1.26+ (matching the go directive in go.mod) and golangci-lint v2.11.3 or later.

go build ./...
golangci-lint run ./...
go test ./...

These three commands are the same ones the CI workflow (.github/workflows/ci.yaml) runs on every pull request. A PR will not be merged with any of them red.

Commit style

Conventional Commit style, lowercase type, optional scope:

<type>(<scope>): <short summary>

Examples from the existing history:

  • fix(helm): handle nil release.Info
  • ci: migrate image publishing from ECR to GHCR
  • chore(deps): bump k8s.io/client-go from 0.35.1 to 0.36.0

Common types: feat, fix, chore, refactor, test, ci, docs.

Pull requests

  • Fill out .github/pull_request_template.md.
  • Link an issue with Fixes #<n> when one exists.
  • Keep the PR scoped to a single concern. If reviewers ask for unrelated changes, push back or split into a follow-up PR.
  • Add or update tests for behavior changes. Pure refactors do not need new tests but must keep the existing suite green.
  • Dependency bumps are handled by Dependabot; manual go.mod edits should explain why in the commit body.

License

By contributing, you agree that your contributions will be licensed under the Apache License, Version 2.0. Significant fork-specific contributions are summarized in NOTICE.