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.

Sign up for GitHub

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

Jump to bottom

update change log entry types and add to pull request template #1831

Merged
merged 5 commits into from
Aug 20, 2024
Merged

update change log entry types and add to pull request template #1831

merged 5 commits into from
Aug 20, 2024

Conversation

zacharyburnett
Copy link
Member

Description

Checklist:

  • pre-commit checks ran successfully
  • tests ran successfully
  • for a public change, added news fragment (changes/<PR#>.<changetype>.rst)
  • for a public change, updated documentation
  • for any new features, unit tests were added

@zacharyburnett zacharyburnett force-pushed the docs/pull_request_change_types branch from 6661c12 to a99b1c9 Compare August 20, 2024 14:10
@zacharyburnett
Copy link
Member Author

zacharyburnett commented Aug 20, 2024 •
edited
Loading

  • pre-commit checks ran successfully

  • tests ran successfully

  • for a public change, added a towncrier news fragment

    changes/<PR#>.<changetype>.rst

    • changes/<PR#>.feature.rst: new feature
    • changes/<PR#>.bugfix.rst: bug fix
    • changes/<PR#>.doc.rst: documentation change
    • changes/<PR#>.removal.rst: deprecation or removal of public API
    • changes/<PR#>.general.rst: infrastructure or miscellaneous change

  • for a public change, updated documentation

  • for any new features, unit tests were added

@braingram
Copy link
Contributor

If it works for you would you update this PR to also define the sections in the pyproject.toml file? For misc how aboutgeneral (to match some of the other repos) and set it to showcontent=True?

@zacharyburnett zacharyburnett force-pushed the docs/pull_request_change_types branch from 08da7bd to bef0ebd Compare August 20, 2024 14:33
@zacharyburnett zacharyburnett marked this pull request as ready for review August 20, 2024 14:35
@zacharyburnett zacharyburnett requested a review from a team as a code owner August 20, 2024 14:35
@braingram
Copy link
Contributor

Changes look good and it's good to see the changelog check fail due to the misc fragment. Would you rename 1828.misc.rst it to 1828.general.rst?

@zacharyburnett zacharyburnett self-assigned this Aug 20, 2024
@zacharyburnett zacharyburnett changed the title update pull request template to include collapsed explanation of change log entry types update change log entry types and add to pull request template Aug 20, 2024
braingram
braingram approved these changes Aug 20, 2024
View reviewed changes
Copy link
Contributor

@braingram braingram left a comment

Choose a reason for hiding this comment

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

Thanks!

@zacharyburnett zacharyburnett merged commit 7feeb71 into asdf-format:main Aug 20, 2024
39 of 49 checks passed
@zacharyburnett zacharyburnett deleted the docs/pull_request_change_types branch August 20, 2024 18:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@braingram braingram braingram approved these changes

Assignees

@zacharyburnett zacharyburnett

Labels
no-changelog-entry-needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@zacharyburnett @braingram