Skip to content

Conversation

@dralley
Copy link
Contributor

@dralley dralley commented Jan 20, 2026

Includes a checklist for contributors

📜 Checklist

  • Commits are cleanly separated and have useful messages
  • A changelog entry or entries has been added for any significant changes
  • Follows the Pulp policy on AI Usage
  • (For new features) - User documentation and test coverage has been added

Includes a checklist for contributors
@dralley dralley marked this pull request as draft January 21, 2026 04:56
Copy link
Member

@mdellweg mdellweg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With mkdocs, there's a way to move all the links into a references section in the end, if you want to make the bulk "more readable".

Comment on lines +19 to +20
4. If the PR is a simple feature or a bugfix, please [`rebase and squash`](site:pulpcore/docs/dev/guides/git/#markdown-header-rebasing-and-squashing) to a single commit. If the PR
is a complex feature, make sure that all commits are cleanly separated and have meaningful commit messages.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
4. If the PR is a simple feature or a bugfix, please [`rebase and squash`](site:pulpcore/docs/dev/guides/git/#markdown-header-rebasing-and-squashing) to a single commit. If the PR
is a complex feature, make sure that all commits are cleanly separated and have meaningful commit messages.
4. If the PR is a simple feature or a bugfix, please [`rebase and squash`](site:pulpcore/docs/dev/guides/git/#markdown-header-rebasing-and-squashing) to a single commit.
If the PR is a complex feature, make sure that all commits are cleanly separated and have meaningful commit messages.

{doc}`file an issue</bugs-features>`.
4. If the PR is a simple feature or a bugfix, please [`rebase and squash`](site:pulpcore/docs/dev/guides/git/#markdown-header-rebasing-and-squashing) to a single commit. If the PR
is a complex feature, make sure that all commits are cleanly separated and have meaningful commit messages.
5. Make sure you tag commits with `closes #IssueNumber` or `ref #IssueNumber` when working on a tracked issue
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
5. Make sure you tag commits with `closes #IssueNumber` or `ref #IssueNumber` when working on a tracked issue
5. Make sure you tag commits with `closes #IssueNumber` or `ref #IssueNumber` when working on a tracked issue.

4. If the PR is a simple feature or a bugfix, please [`rebase and squash`](site:pulpcore/docs/dev/guides/git/#markdown-header-rebasing-and-squashing) to a single commit. If the PR
is a complex feature, make sure that all commits are cleanly separated and have meaningful commit messages.
5. Make sure you tag commits with `closes #IssueNumber` or `ref #IssueNumber` when working on a tracked issue
6. If AI was used, please make sure you are following the [Pulp policy on AI Usage](site:help/more/governance/ai_policy/)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
6. If AI was used, please make sure you are following the [Pulp policy on AI Usage](site:help/more/governance/ai_policy/)
6. If AI was used, please make sure you are following the [Pulp policy on AI Usage](site:help/more/governance/ai_policy/).

We don't use "please" anywhere else.

Comment on lines +24 to +25
8. If the change requires a corresponding change in pulp-cli, open a PR against the pulp-cli or docs, or
`file an issue`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
8. If the change requires a corresponding change in pulp-cli, open a PR against the pulp-cli or docs, or
`file an issue`.
8. If the change requires a corresponding change in pulp-cli, open a PR against the pulp-cli.

Let's not make it sound as if you could just push out the work to someone else. If it's "required" it "should be done".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants