Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
83 lines (60 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

83 lines (60 loc) · 2.87 KB
Raw

Contributing

How to Contribute

Reporting bugs

Open a GitHub Issue with:

  • Steps to reproduce
  • Expected vs. actual behaviour
  • Your pack version and docker version output

Submitting changes

  1. Fork the repository
  2. Create a feature branch: git checkout -b feat/my-feature
  3. Make your changes (see guidelines below)
  4. Run smoke tests: make test-smoke
  5. Open a Pull Request against main

Development Setup

Tool Min version
Docker 20.10
pack CLI 0.33
Java / Maven JDK 25+ (for Java samples)
make any
hadolint (optional) 2.x 
git clone https://github.com/patbaumgartner/distroless-buildpack-builder-java-tiny.git
cd distroless-buildpack-builder-java-tiny

make build-stack    # Build stack images (requires Docker)
make build-builder  # Assemble the CNB builder (requires pack)
make test-smoke     # Run smoke tests
make test           # Run full integration tests

Pull Request Guidelines

  • All smoke tests must pass (make test-smoke)
  • Run make lint and address Hadolint warnings
  • Update README.md if you change public-facing behaviour
  • Keep PRs focused on a single concern
  • All Quality Gates and Security Scan checks must be green (see the Quality Contract in the README)

Maintainer Checklist — Adding a New Sample

When adding a new sample application under samples/, update all of the following to keep the repository in sync:

  • .github/workflows/benchmark.yml — add the sample to the benchmark matrix
  • .github/workflows/test.yml — add pack build and container verification steps
  • .github/workflows/quality-gates.yml — add the sample to the java-static-analysis matrix
  • .github/dependabot.yml — add dependency tracking for the new sample
  • tests/integration/test_builder.sh — add the sample to the integration test loop
  • README.md — update the Sample Applications table
  • New sample README.md — include Endpoints, Build, Tests, and Runtime Constraints sections

Commit Style

Follow Conventional Commits:

feat(stack): upgrade distroless to latest nonroot tag
fix(builder): correct lifecycle version constraint
chore(deps): bump ubuntu base image to 24.04
docs: add section on custom stack IDs

Updating Buildpack Versions

Pinned versions in builder.toml are managed automatically by Renovate. To update manually:

  1. Find the current tag on GHCR (e.g. ghcr.io/paketobuildpacks/java)
  2. Update the uri in the [[buildpacks]] block
  3. Update the matching version in the [[order.group]] block
  4. Build and test locally

License

By contributing, you agree your contributions will be licensed under Apache 2.0.