Merged
Conversation
### Fixed - **Kotlin Header Preservation**: Fixed a bug where multi-line block comments (`/** ... */`) in Kotlin files were not correctly preserved, leading to malformed docstrings. The header parsing logic now correctly identifies and preserves these comment blocks. (Fixes #9) ### Added - Added a new test to verify the preservation of multi-line comments in Kotlin files.
### Fixed - **Kotlin Header Preservation**
### Changed - Updated the description of Agent Docstrings to clarify its role in solving the "cold start" problem for AI agents navigating large codebases. - Added a new section detailing the advantages of using Agent Docstrings, contrasting the "Blind" approach with the "Map-First" approach. - Introduced a "Support the Project" section to encourage contributions and support for the ongoing development of the tool. ### Improved - Enhanced clarity and engagement in the README to better communicate the tool's benefits and encourage community involvement.
another day, another fix
### Fixed - **Python Docstring Cleaning**: (fixes #11) - **C-Style Comment Handling**:
### Fixed - **Python Docstring Cleaning**: (fixes #11) - **C-Style Comment Handling**:
### Changed - Updated the test for existing auto docstring replacement to dynamically check the version of Agent Docstrings using the `__version__` variable instead of a hardcoded string.
### Changed - Updated the video tag in README.md to include `playsinline` and added styling for improved presentation, including `border-radius` and `box-shadow` for a more polished look.
### Changed - Replaced the video tag with an image tag for the demo in README.md, using a WebP format and added a fallback message for unsupported browsers. - Introduced a new WebP image file for the demo presentation.
### Changed - Added a new function `_normalize_content_for_version_comparison` to remove version-specific information from content, allowing for version-independent comparisons. - Updated the `process_file` function to utilize the normalization function, ensuring that files are only modified when content changes, excluding version-only differences. - Introduced a new test `test_version_only_change_skips_modification` to verify that files are not modified when only the version number differs in the auto-generated header.
### Changed - Adjusted the test cases in `test_docstring_duplication.py` to reflect the new versioning and ensure proper functionality. - Introduced a new test file `test_version_change.py` to verify that files are not modified when only the version number differs in the auto-generated header. - Enhanced the logic in `process_file` to handle version comparisons more effectively, ensuring that only meaningful content changes trigger file modifications.
### Changed - Fixed a critical bug causing line numbers in the table of contents to change on every run due to inconsistent newline handling, ensuring deterministic processing. - Improved detection logic for removing agent-generated docstrings, allowing for robust handling even with multiple erroneous docstrings present. - Ensured manual docstrings are preserved and not modified unless merging with an agent-generated table of contents. - Added a test to verify that files with only manual docstrings remain unchanged after processing. - Enhanced tests to ensure trailing whitespace and blank lines are preserved during docstring removal.
### Changed - Modified the CI workflow to trigger tests on pushes to the `dev` branch instead of `master`. - Added caching for Go modules and pip dependencies in the CI workflow to improve build performance. - Introduced a new release automation workflow that creates a GitHub release upon merging pull requests from `release/*` branches into `master`, extracts version information, and generates changelog notes. - Implemented a back-merge PR to sync `master` back into `dev` after a release.
### Added - Introduced a `CONTRIBUTING.md` file with comprehensive guidelines for contributing to the project. - Updated `README.md` to link to the new contribution guide and clarify the automated release process. - Implemented a new `release-automation.yml` workflow for automatic Git tagging, GitHub Releases, and back-merging PRs upon merging release branches into master. - Optimized the CI pipeline by removing redundant test runs on master branch pushes and adding caching for pip dependencies and Go modules. ### Changed - Adjusted CI triggers to run on pushes to `dev` instead of `master`, improving workflow efficiency.
### Changed - Enhanced the `CONTRIBUTING.md` file to include instructions for linking issues in the changelog entries. - Streamlined the `.github/PULL_REQUEST_TEMPLATE.md` by removing unnecessary sections and clarifying the checklist items for contributors. ### Added - Included a Contribution Guide link and a reminder for contributors to update the `CHANGELOG.md` under the `[NextRelease]` section in the pull request template.
Fixed - Deterministic Processing - Robust Docstring Removal - Manual Docstring Preservation - Version-Only Change Skipping
Documentation - Contribution Guide - README Update CI/CD - Release Automation - CI Optimization - Workflow Efficiency - Version Check Precision
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #16 +/- ##
==========================================
+ Coverage 89.73% 90.52% +0.79%
==========================================
Files 12 12
Lines 711 718 +7
==========================================
+ Hits 638 650 +12
+ Misses 73 68 -5 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixed
Documentation
CONTRIBUTING.mdfile with detailed guidelines for development workflow and the release process.README.mdto link to the new contribution guide and reflect the automated release process.CI/CD
release-automation.ymlworkflow that automatically creates Git tags, GitHub Releases, and back-merge PRs when release branches are merged to master.devinstead ofmaster, eliminating duplicate test runs while maintaining comprehensive coverage.pyproject.tomlandagent_docstrings/__init__.py, preventing false positives from other file modifications.Type of Change
Checklist
CHANGELOG.mdunder the[NextRelease]section.