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 #241

Merged
merged 1 commit into from
Jan 5, 2025
Merged

Add CHANGELOG #241

merged 1 commit into from
Jan 5, 2025

Conversation

bessman
Copy link
Collaborator

@bessman bessman commented Jan 5, 2025

Summary by Sourcery

Chores:

  • Add a changelog file to track changes in the project.

Copy link

sourcery-ai bot commented Jan 5, 2025

Reviewer's Guide by Sourcery

This pull request introduces a CHANGELOG file to track changes made to the project. The file includes entries for versions 3.1.0 and 3.1.1, outlining changes made in each version such as raising a RuntimeError under specific conditions and fixing an issue that made the I2C bus unusable after a device scan.

Sequence diagram for I2C peripheral start behavior

sequenceDiagram
    participant Client
    participant I2CPrimitive
    Note over I2CPrimitive: New behavior in 3.1.1
    Client->>I2CPrimitive: _start()
    alt peripheral is already active
        I2CPrimitive-->>Client: raise RuntimeError
    else peripheral is inactive
        I2CPrimitive-->>Client: start peripheral
    end
Loading

Sequence diagram for I2C bus device scan fix

sequenceDiagram
    participant Client
    participant I2CBus
    Note over I2CBus: Fixed in 3.1.1
    Client->>I2CBus: scan devices
    I2CBus-->>Client: return device list
    Note over I2CBus: Bus remains usable
    Client->>I2CBus: subsequent operations
    I2CBus-->>Client: normal operation
Loading

File-Level Changes

Change Details Files
Add a CHANGELOG file.
  • Created a new CHANGELOG file.
  • Added version 3.1.1 and 3.1.0 entries.
  • Included specific changes for each version like raising RuntimeError and fixing I2C bus issues.
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 @bessman - 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.

@bessman bessman merged commit 8ce3072 into fossasia:development Jan 5, 2025
2 checks passed
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.

1 participant