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

Switch to new changelog format #777

Merged
merged 6 commits into from
Dec 13, 2022
Merged

Switch to new changelog format #777

merged 6 commits into from
Dec 13, 2022

Conversation

djdameln
Copy link
Contributor

@djdameln djdameln commented Dec 8, 2022

Description

  • Updates the changelog to the new format and adds [unreleased] section.
  • Add instruction in contributing guidelines.
  • Adds a checkbox to the PR template.

Changes

  • Bug fix (non-breaking change which fixes an issue)
  • Refactor (non-breaking change which refactors the code base)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist

  • My code follows the pre-commit style and check guidelines of this project.
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing tests pass locally with my changes

Copy link
Collaborator

@ashwinvaidya17 ashwinvaidya17 left a comment

Choose a reason for hiding this comment

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

Thanks

Copy link
Contributor

@samet-akcay samet-akcay left a comment

Choose a reason for hiding this comment

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

Thanks. Despite adding some complexity to PR making process, this seems to be a lot more descriptive to users!

@samet-akcay samet-akcay merged commit eaa5d49 into main Dec 13, 2022
@samet-akcay samet-akcay deleted the da/update-changelog branch December 13, 2022 13:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants