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

Add CHANGELOG.md with autogenerated changelog #83

Merged
merged 2 commits into from
Oct 14, 2024
Merged

Add CHANGELOG.md with autogenerated changelog #83

merged 2 commits into from
Oct 14, 2024

Conversation

cvele
Copy link
Owner

@cvele cvele commented Oct 14, 2024

Summary by Sourcery

Documentation:

  • Add a new CHANGELOG.md file with an autogenerated changelog using github_changelog_generator.

@sourcery-ai review

@cvele cvele enabled auto-merge (squash) October 14, 2024 13:11
@sourcery-ai sourcery-ai bot changed the title $NEW_VERSION @sourcery-ai Add CHANGELOG.md with autogenerated changelog Oct 14, 2024
Copy link

sourcery-ai bot commented Oct 14, 2024

Reviewer's Guide by Sourcery

This pull request adds a new CHANGELOG.md file to the repository, which contains an automatically generated changelog using the github_changelog_generator tool. The changelog provides a comprehensive list of changes, merged pull requests, and version information for the project.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Add an automatically generated CHANGELOG.md file
  • Create a new CHANGELOG.md file at the root of the repository
  • Include an 'Unreleased' section with links to the latest changes
  • List merged pull requests with their respective numbers and authors
  • Add a 'Full Changelog' link comparing the latest changes to the previous version
  • Include information about the v0.0.3 release
  • Add a note about the changelog being automatically generated by github_changelog_generator
CHANGELOG.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @cvele - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@cvele cvele merged commit efefdbb into main Oct 14, 2024
5 checks passed
@cvele cvele deleted the release/0.0.4 branch October 14, 2024 13:13
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.

2 participants