Skip to content

Changelog for v0.1.0 + README updates#5

Merged
igoropaniuk merged 2 commits intomainfrom
docs/changelog_for_v0.1.0
Mar 13, 2026
Merged

Changelog for v0.1.0 + README updates#5
igoropaniuk merged 2 commits intomainfrom
docs/changelog_for_v0.1.0

Conversation

@igoropaniuk
Copy link
Owner

No description provided.

Replace dev-centric setup instructions (Prerequisites,
Fetching the project, poetry install) with a standalone
Installation section covering pip and pipx, since users are expected
to install from PyPI rather than from source.

Drop poetry run prefixes from all usage examples so they reflect the
installed CLI invocation. Consolidate the Usage section heading that
previously doubled as a Poetry install guide.

Signed-off-by: Igor Opaniuk <igor.opaniuk@gmail.com>
Signed-off-by: Igor Opaniuk <igor.opaniuk@gmail.com>
@gemini-code-assist
Copy link

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a formal changelog for version 0.1.0, detailing new features, fixes, and changes. Concurrently, it updates the project's README to streamline installation instructions and usage examples, making it easier for new users to get started with the CLI tool.

Highlights

  • Changelog Introduction: A new CHANGELOG.md file was added, formally documenting all notable changes for version 0.1.0, adhering to the Keep a Changelog and Semantic Versioning standards.
  • Streamlined Installation: The README.md was updated to simplify the installation process, now recommending pip or pipx and removing previous Poetry-specific setup instructions.
  • Updated Usage Examples: Command examples in the README.md were revised to reflect direct stonks command execution, removing the poetry run prefix, and improving clarity.
Changelog
  • CHANGELOG.md
    • Added a new changelog file documenting version 0.1.0, including new features, fixes, and changes.
  • README.md
    • Updated installation instructions to use pip and pipx.
    • Removed Poetry-specific setup instructions.
    • Revised usage examples to remove poetry run prefix and reordered sections for better flow.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds a changelog for the v0.1.0 release and updates the README with user-friendly installation instructions. The changes in the README are well-done, shifting the focus from a developer setup to a user installation via pip or pipx. I've found a minor issue in the new CHANGELOG.md file regarding the release date.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.1.0] - 2026-03-13

Choose a reason for hiding this comment

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

medium

The release date for version 0.1.0 is set to a future date (2026-03-13). This appears to be a typo. Please correct it to the actual release date.

@igoropaniuk igoropaniuk merged commit d143a65 into main Mar 13, 2026
16 checks passed
@igoropaniuk igoropaniuk deleted the docs/changelog_for_v0.1.0 branch March 13, 2026 09:42
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