Skip to content
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

packaging: update commit instructions to follow Git commit hook and link package requests #544

Merged
merged 2 commits into from
May 25, 2024

Conversation

silkeh
Copy link
Member

@silkeh silkeh commented May 25, 2024

Description

  • Add instructions to follow the template shown in the editor.
  • Remove 'Test Plan' and 'Checklist' from example commits.
  • Add to packaging changes.
  • Add issue link for new packages.

silkeh added 2 commits May 25, 2024 13:21
- Add instructions to follow the template shown in the editor.
- Remove 'Test Plan' and 'Checklist' from example commits.
- Add to packaging changes.
…g PRs

Add an issue link to the new package documentation so package requests are automatically resolved.
This makes the workflow match more with 'Updating an Existing Package'.

No entry to the packaging changes is needed, as linking an issue is also part of 'Creating the pull
request' steps.
Copy link
Member

@EbonJaeger EbonJaeger left a comment

Choose a reason for hiding this comment

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

LGTM! Will leave this open a little longer in case anyone else has comments.

There should be a summary line (with the package name), a blank line, and then the rest of the commit message.

- There should at the minimum be a Summary and Test Plan.
- There should at the minimum be a Summary.
Copy link
Member

Choose a reason for hiding this comment

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

I was going to quibble with "at the minimum" vs "at a minimum", but apparently this usage is common enough.

LGTM.

@davidjharder davidjharder merged commit d58b996 into master May 25, 2024
1 check passed
@davidjharder davidjharder deleted the update-commit-examples branch May 25, 2024 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants