Contributing to Agent Shadow Brain

April 19, 2026 ยท View on GitHub

First off, thank you for considering contributing! It's people like you that make this project great.

How Can I Contribute?

Reporting Bugs

  • Check if the bug has already been reported in Issues
  • Open a new issue using the Bug Report template
  • Include a clear title, description, and steps to reproduce

Suggesting Features

  • Check existing issues and discussions first
  • Open a new issue using the Feature Request template
  • Describe the use case and expected behavior

Submitting Pull Requests

  1. Fork the repository
  2. Create a feature branch (git checkout -b feat/my-feature)
  3. Make your changes
  4. Add tests for any new functionality
  5. Ensure all tests pass (npm test)
  6. Commit with a clear message (see convention below)
  7. Open a Pull Request against main

Commit Convention

Use Conventional Commits:

feat: add new cognitive pattern
fix: resolve memory leak in shadow engine
docs: update API reference
refactor: simplify brain pipeline
test: add unit tests for persona module
chore: update dependencies

Coding Standards

  • Clean, readable code with meaningful names
  • Add comments for complex logic
  • Follow existing code style in the project
  • Keep functions small and focused
  • Handle errors gracefully

Questions?

Feel free to open a Discussion for any questions or ideas.