-
Notifications
You must be signed in to change notification settings - Fork 33
docs: add pull request templates #223
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
gbartolini
wants to merge
2
commits into
main
Choose a base branch
from
docs/pr-templates
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| <!-- | ||
| Thanks for contributing a new extension to the PostgreSQL Extensions Containers | ||
| project! | ||
|
|
||
| Before opening this PR, please make sure you have read: | ||
| - CONTRIBUTING_NEW_EXTENSION.md (lifecycle for adding an extension) | ||
| - BUILD.md (build system) | ||
| - the general CloudNativePG CONTRIBUTING.md: | ||
| https://github.com/cloudnative-pg/governance/blob/main/CONTRIBUTING.md | ||
| --> | ||
|
|
||
| ## Extension | ||
|
|
||
| <!-- Name of the extension and a short description of what it does and its | ||
| primary use case. --> | ||
|
|
||
|
|
||
|
|
||
| Closes #<!-- proposal issue id --> | ||
|
|
||
| --- | ||
|
|
||
| ## Contributor checklist | ||
|
|
||
| <!-- All items must be addressed before requesting a review. --> | ||
|
|
||
| - [ ] My commits are signed off for [DCO](https://developercertificate.org/) | ||
| compliance (`git commit -s`). | ||
| - [ ] Experimental commits have been squashed into a single, well-formed commit. | ||
| - [ ] This PR targets the `main` branch of the upstream repository. | ||
| - [ ] A [New Extension Proposal](https://github.com/cloudnative-pg/postgres-extensions-containers/issues/new/choose) | ||
| issue exists and is referenced via `Closes #<id>` above. | ||
| - [ ] The commit message follows the format: | ||
| ``feat: add `<extension-name>` container image``. | ||
| - [ ] The Debian package was verified to exist in the `main` component on both | ||
| Debian `stable` (`trixie`) and `oldstable` (`bookworm`) via `apt search`. | ||
| - [ ] The extension was scaffolded with `task create-extension NAME=<ext>` and all | ||
| `TODO` comments in the generated files were resolved. | ||
| - [ ] `metadata.hcl` sets the correct `package` (full Debian version) and, when | ||
| `create_extension = true`, the matching `sql` (catalog) version. | ||
| - [ ] `create_extension` is set correctly (`false` for PostgreSQL *modules* with | ||
| no `.control` file, verified with `dpkg -L`). | ||
| - [ ] The `renovate:` annotations in `metadata.hcl` and `README.md` are present | ||
| and intact (`suite=`, `depName=`, `extractVersion=`). | ||
| - [ ] Every component in the image is covered by a license on the | ||
| [CNCF Allowlist](https://github.com/cncf/foundation/blob/main/policies-guidance/allowed-third-party-license-policy.md); | ||
| SPDX `licenses` in `metadata.hcl` are accurate. | ||
| - [ ] `task checks:all` passes locally. | ||
| - [ ] Full E2E passes: `task e2e:test:full TARGET="<extension-name>"`. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is already covered by the CI |
||
| - [ ] `README.md` is complete and includes a working `Cluster` example (plus a | ||
| `Database` example with `CREATE EXTENSION` when `create_extension = true`). | ||
| - [ ] An entry for the new extension folder was added to | ||
| [`CODEOWNERS`](https://github.com/cloudnative-pg/postgres-extensions-containers/blob/main/CODEOWNERS) | ||
| with the component owner's GitHub handle(s). | ||
| - [ ] I confirm my commitment to maintain this extension on behalf of the | ||
| CloudNativePG community. | ||
|
|
||
| --- | ||
|
|
||
| ## Maintainer review checklist | ||
|
|
||
| <!-- For maintainers only. Do not merge until every item is verified. --> | ||
|
|
||
| - [ ] The linked proposal issue is approved (label `new-extension`) and the | ||
| `Closes #<id>` reference is correct. | ||
| - [ ] CI is green: the `bake` workflow built the new target for the full | ||
| `pgVersions × distributions × {amd64, arm64}` matrix. | ||
| - [ ] DCO check passes and history is a single clean commit with the required | ||
| `feat: add ...` message format. | ||
| - [ ] License compliance reviewed: all redistributed components (extension + | ||
| transitive/system libs) are on the CNCF Allowlist; SPDX `licenses` match. | ||
| - [ ] `metadata.hcl` reviewed: `package`/`sql` versions, `create_extension`, | ||
| runtime settings (`shared_preload_libraries`, `*_path`, `env`, | ||
| `required_extensions`) and behavior flags are correct. | ||
| - [ ] `renovate:` annotations are intact so automated version PRs will track | ||
| the package going forward. | ||
| - [ ] `Dockerfile` reviewed: final stage is `FROM scratch` and contains only the | ||
| expected artifacts; the `USER 65532:65532` directive matches the nonroot | ||
| convention. | ||
| - [ ] E2E / Chainsaw tests pass: the extension is registered (when | ||
| `create_extension = true`), or the Cluster reaches Healthy with the image | ||
| mounted for preload-only modules. | ||
| - [ ] `README.md` is clear and its `Cluster` example (and `Database` example | ||
| when `create_extension = true`) are valid. | ||
| - [ ] `CODEOWNERS` entry is present and the component owner(s) accept the | ||
| long-term maintenance commitment. | ||
| - [ ] PR targets `main` and is ready to merge. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| <!-- | ||
| Thanks for contributing to the PostgreSQL Extensions Containers project! | ||
|
|
||
| This template is for changes other than adding a new extension (version bumps, | ||
| fixes, shared build/tooling changes, documentation, ...). If you are adding a | ||
| new extension, use the "new_extension" template instead by appending | ||
| `?template=new_extension.md` to the PR creation URL. | ||
|
|
||
| Before opening this PR, please read BUILD.md and the general CloudNativePG | ||
| CONTRIBUTING.md: | ||
| https://github.com/cloudnative-pg/governance/blob/main/CONTRIBUTING.md | ||
| --> | ||
|
|
||
| ## Description | ||
|
|
||
| <!-- Explain what this PR does and why. --> | ||
|
|
||
|
|
||
|
|
||
| ## Type of change | ||
|
|
||
| <!-- Tick the box that applies (put an "x" between the brackets, no spaces). --> | ||
|
|
||
| - [ ] Update to an existing extension (version bump, fix) | ||
| - [ ] Shared build infrastructure / tooling change | ||
| - [ ] Documentation only | ||
| - [ ] Other (please describe above) | ||
|
|
||
| <!-- If this fixes an open issue, reference it here, for example: Closes #123 --> | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| ## Contributor checklist | ||
|
|
||
| - [ ] My commits are signed off for [DCO](https://developercertificate.org/) | ||
| compliance (`git commit -s`). | ||
| - [ ] This PR targets the `main` branch of the upstream repository. | ||
| - [ ] `task checks:all` passes locally. | ||
| - [ ] For changes affecting one or more extensions, the relevant build and E2E | ||
| tests pass (e.g. `task bake TARGET=<ext>`, `task e2e:test:full TARGET=<ext>`). | ||
| - [ ] Any `// renovate:` comments touched in `metadata.hcl` / `README.md` remain | ||
| intact (`suite=`, `depName=`, `extractVersion=`). | ||
| - [ ] Documentation (`README.md`, `BUILD.md`, ...) updated where relevant. | ||
|
|
||
| --- | ||
|
|
||
| ## Maintainer review checklist | ||
|
|
||
| <!-- For maintainers only. --> | ||
|
|
||
| - [ ] CI is green for all affected targets / shared changes. | ||
| - [ ] DCO check passes. | ||
| - [ ] Change reviewed for correctness and scope; no unintended targets rebuilt. | ||
| - [ ] `// renovate:` annotations preserved so automated version tracking keeps | ||
| working. | ||
| - [ ] If shared infrastructure changed, the `_shared` filter in | ||
| `.github/workflows/bake.yml` was updated when all extensions must rebuild. | ||
| - [ ] PR targets `main` and is ready to merge. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this really required? It performs a local
docker buildx bake --checkfor all the extensionsThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is what
CONTRIBUTING_NEW_EXTENSION.mdsays, though.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, I think that's fine to be there as we are informing how to do local testing (even if it should just target the extension being proposed and not
all), but once the PR is opened we probably should just rely on CI results.