Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (34 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

48 lines (34 loc) · 1.82 KB
Raw

Contributing

Leer en español

Thank you for your interest in contributing to PostgreSQL Extensor.

Reporting issues

Use the templates in .github/ISSUE_TEMPLATE/:

  • Bug report: for errors or unexpected behavior.
  • Feature request: to suggest new extensions or features.
  • Custom: for anything else.

Pull Requests

  1. Fork the repository.

  2. Create a branch with a descriptive name: feat/pg-partman, fix/pgvector-build.

  3. Run the tests for at least one version locally:

    make test PG_VERSION=18

  4. If you're adding an extension, follow Extensions. It comes down to a line in extensions/pgdg.txt (or a few in the Dockerfile), an extensions/<name>/test.sql, and a row in Included extensions.

  5. Open the PR against main. CI builds and tests every version on amd64 and arm64.

Merging only updates the floating tags (18, latest). Maintainers cut releases to update the versioned tags (see Releases).

Guidelines

  • Prefer PGDG apt packages over building from source.
  • Pin every extension version, apt packages included, using an ARG with a # renovate: comment.
  • Build tools go in build-base, never in the final stage.

Project structure

Dockerfile            Image definition (one stage per extension built from source)
docker-bake.hcl       PostgreSQL versions and tags
extensions/pgdg.txt   PGDG packages and their versions
extensions/*.sh       Build helpers used by the Dockerfile
extensions/<name>/    test.sql for each extension (plus optional server.conf, ...)
tests/run.sh          Runs every test.sql against an image
.github/workflows/    CI: build, test, publish, release
.github/scripts/      Helpers used by CI (release notes)
.docs/                Documentation