Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (41 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

63 lines (41 loc) · 1.68 KB

Contributing to greybeard

Thanks for your interest in contributing! 🎉

Quick Links

Ways to Contribute

1. Content Packs (Easiest!)

Content packs are the highest-value contribution. Create a new perspective:

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

See Pack Schema for details.

2. Bug Reports

Found a bug? Open an issue

3. Feature Requests

Have an idea? Suggest a feature

4. Code Contributions

See the full guide for:

  • Development setup
  • Running tests
  • Code style
  • 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.