Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
100 lines (67 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

100 lines (67 loc) · 2.87 KB

Contributing to greybeard

Thanks for your interest in contributing! 🎉

Quick Links

Ways to Contribute

1. Content Packs (Easiest, Highest Value!)

Create a new perspective for your team or community:

cd packs/
cp staff-core.yaml my-new-pack.yaml
# Edit your pack definition
git diff HEAD~1 | greybeard analyze --pack packs/my-new-pack.yaml

Pack Ideas:

  • Security engineer reviewing auth/injection/secrets
  • Data engineer reviewing migrations/schemas
  • Mobile engineer reviewing client/server contracts
  • SRE reviewing SLOs/error budgets/toil

See Pack Schema and Packs Guide for details.

2. Custom Agents (Advanced)

Build specialized decision-making tools using the framework:

from greybeard.common import BaseAgent

class MyCustomAgent(BaseAgent):
    def __init__(self):
        super().__init__(name="my-agent", description="...")
    
    def run(self, user_input: str) -> dict:
        context = self.research.gather_file_context("file.txt")
        response = self.llm.call(...)
        return {"result": response}

See Creating Agents Guide and template.

3. Interactive Mode Improvements

Enhance the stateful conversation REPL:

  • New interactive commands or workflows
  • Better context management for long sessions
  • Improved streaming UX
  • Bug fixes

See Contributing to Interactive Mode in docs/contributing.md.

4. Bug Reports

Found a bug? Open an issue with steps to reproduce.

5. Feature Requests

Have an idea? Suggest a feature.

6. Code Contributions

See the full guide for:

  • Development setup
  • Running tests
  • Code style and formatting
  • Interactive mode development
  • Commit guidelines

Quick Dev Setup

git clone https://github.com/btotharye/greybeard.git
cd greybeard
make install-dev           # Install dependencies
make pre-commit-install    # Install git hooks (recommended)
make test                  # Run tests

See the full development guide for details on pre-commit hooks, coverage reports, type checking, and more.

Questions?

For the full contributing guide with detailed instructions, see docs/contributing.md.