Configure templates and AI docs

[bjester]

Summary

• Add documentation for AI

[gemini-code-assist]

Summary of Changes

Hello @bjester, I'm Gemini Code Assist¹! 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 primarily focuses on integrating and configuring AI-related documentation and exclusion rules within the project. It establishes guidelines for unit testing and a comprehensive style guide, alongside general project instructions for AI agents. Additionally, it refines the project's ignore and build configurations to accommodate these new AI-related files and directories.

Highlights

• AI Configuration Files: Introduced .aiexclude and .aiignore files to specify paths that should be excluded or ignored by AI tools, ensuring relevant files are processed.
• AI Documentation Templates: Added new documentation templates for AI tools, including unit test guidelines, a project style guide, and general project instructions for agents.
• Git Ignore Updates: Modified the .gitignore file to incorporate new AI-related directories, common IDE files, macOS specific files, and pytest cache, improving repository cleanliness.
• Build Configuration Adjustments: Updated pyproject.toml to exclude newly added AI-related directories and the playground/ directory from source and wheel builds, streamlining the build process.

Changelog

• .aiexclude
  • Added initial ignore patterns for AI tools.
• .aiignore
  • Added initial ignore patterns for AI tools.
• .gh/worktree/templates/.aiassistant/rules/tests.md
  • Added unit test guidelines for Python projects, covering structure, naming, best practices, and tools.
• .gh/worktree/templates/.gemini/styleguide.md
  • Added a comprehensive Python style guide for the gh-worktree project, detailing key principles, PEP 8 deviations, naming conventions, docstrings, type hints, and comments.
• .gh/worktree/templates/AGENTS.md
  • Added instructions for AI agents, outlining the project's introduction, structure, development environment tooling, and references to style guides.
• .gitignore
  • Updated ignore patterns to include .vscode, *.swp, .DS_Store, .pytest_cache/, and several AI-related directories (.aiassistant/, .junie/, .gemini/, AGENTS.md).
  • Removed .aiassistant/ from an earlier ignore section.
• pyproject.toml
  • Updated source-exclude list to include .gh/ and playground/ directories.

Activity

• No human activity has been recorded on this pull request yet.

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. ↩

[github-actions]

🎉 Build Assets are ready!

File	Checksum
gh_worktree-0.1.1-py3-none-any.whl	``
gh-worktree.pex	``

[gemini-code-assist]

Code Review

The pull request successfully sets up AI-related documentation and templates, which will greatly assist in maintaining code quality and consistency. The use of pytest with unittest and the clear naming conventions for tests are excellent choices. I have noted a few areas for improvement, primarily focusing on ensuring that the git ignore patterns correctly cover worktrees and resolving a path inconsistency between the new templates and the existing test suite. Clarifying the import grouping rule in the style guide will also help avoid ambiguity for future contributors.