Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (50 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

79 lines (50 loc) · 2.14 KB

Contributing to Git AI

Thank you for your interest in contributing to git-ai. This is a cool moment for the industry and we're all here to build a the standard for tracking AI code.

Getting Started

Prerequisites

Development Setup

  1. Fork the repository on GitHub

  2. Clone your fork:

    git clone https://github.com/YOUR_USERNAME/git-ai.git
cd git-ai

  3. Build the project:

    task build

  4. Run the tests:

    task test

Using a development build locally

It's often helpful to point your git-ai to a development build. The dev script builds the binary and installs it to ~/.git-ai/bin/git-ai, replacing the production binary so you can test changes with real git repositories.

task dev

If ~/.git-ai isn't set up yet, the script will run the installer automatically first.

Contributing Changes

Before You Start

  • Check existing issues: Look for related issues or feature requests
  • For new features or architectural changes: We encourage you to chat with the core maintainers first to discuss your approach. This helps ensure your contribution aligns with the project's direction and saves you time.

Submitting a Pull Request

  1. Create a new branch for your changes:

    git checkout -b my-feature-branch

  2. Make your changes and commit them with clear, descriptive messages

  3. Push to your fork:

    git push origin my-feature-branch

  4. Open a Pull Request against the main repository

  5. Reference any related issues in your PR description (e.g., "Fixes #123" or "Related to #456")

  6. Wait for review from the maintainers

Code Style

The project uses standard Rust formatting. Please run task fmt and task lint before committing your changes.

Getting Help

If you have questions about contributing, feel free to open an issue or reach out to the maintainers.