Skip to content

v2.3.2

Choose a tag to compare

View all tags
@saidsef saidsef released this 14 Jul 01:46
· 44 commits to main since this release
v2.3.2
ce9b759
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

🚀 Release v2.3.2: Enhanced Documentation and Inline Commenting Improvements

This release focuses on documentation consistency, inline commenting enhancements, and overall code quality improvements using British English standards.

✨ What's New

📚 Documentation Enhancements

  • ✅ Standardised British spellings throughout codebase (e.g., "initialise" vs "initialize")
  • ✅ Improved function docstring consistency and formatting
  • ✅ Enhanced error handling documentation with proper exception details
  • ✅ Removed redundant whitespace and improved code formatting

🔧 Function Improvements

  • ✅ Updated GitHubIntegration.__init__() with consistent spelling and improved logging
  • ✅ Enhanced PR listing functionality with additional metadata fields (updated_at, author)
  • ✅ Improved inline commenting function documentation with clearer parameter descriptions
  • ✅ Standardised error handling descriptions across all functions

🏗️ Code Quality

  • ✅ Improved MCP server name and instruction clarity
  • ✅ Added proper traceback documentation for debugging purposes
  • ✅ Fixed grammatical issues in inline commenting functions

📦 Installation Instructions

Prerequisites

Ensure you have a GitHub token with appropriate permissions:

export GITHUB_TOKEN="<your-github-token>"

Quick Install via uvx (Recommended)

uvx --from git+https://github.com/saidsef/[email protected] mcp-github-pr-issue-analyser

Alternative Installation Methods

Using uv directly:

uv tool install git+https://github.com/saidsef/[email protected]

Clone and install locally:

git clone https://github.com/saidsef/mcp-github-pr-issue-analyser.git
cd mcp-github-pr-issue-analyser
git checkout v2.3.2
uv install

🎯 Usage

After installation, you can use the MCP GitHub PR and Issue Analyser to:

  • Analyse GitHub pull requests and fetch diffs
  • Create and update GitHub issues
  • Add inline comments to pull requests
  • Create tags and releases
  • Retrieve IP information

💡 Verification

To verify the installation:

mcp-github-pr-issue-analyser --help

🔄 Breaking Changes

None - This is a documentation and quality improvement release with full backward compatibility.

🔗 Related

  • Closes #60 - Documentation consistency improvements
  • Implements changes from PR #59
  • Related to issue #61

👥 Contributors

Thank you to all contributors who helped improve the documentation and code quality in this release!

Full Changelog: v2.3.1...v2.3.2

What's Changed

  • feat: enhance documentation, fix inline commenting, and improve consistency by @saidsef in #59

Full Changelog: v2.3.1...v2.3.2

Contributors

saidsef
Assets 2
Loading