Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
96 lines (70 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

96 lines (70 loc) · 2.25 KB

Contributing to ObservAgent

Thanks for your interest in contributing to ObservAgent!
Contributions of all kinds are welcome — bug reports, feature ideas, documentation improvements, and code.

The goal is to keep contribution simple, respectful, and low-friction.

Ways to Contribute

You don’t need to write code to help.

  • 🐞 Report bugs or unexpected behavior
  • 💡 Suggest features or improvements
  • 📝 Improve documentation or examples
  • 🔧 Submit code changes (fixes, features, refactors)

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Create a new branch: 
    git checkout -b your-branch-name
  4. Make your changes
  5. Commit with a clear message:
git commit -m "Short, descriptive summary of the change"
  1. Push your branch and open a Pull Request

Development Setup

Prerequisites • Node.js 18+ • Python 3 • Claude Code

Install dependencies

npm install
npm --prefix frontend install

Build frontend

npm --prefix frontend run build

Run locally

npm start

Contribution Guidelines

  • Keep changes focused and scoped
  • Prefer clarity over cleverness
  • Follow existing code style and patterns
  • Avoid large refactors unless discussed first
  • Add comments where behavior may not be obvious

If you’re unsure about an approach, open an issue first — discussion is encouraged.

Pull Request Expectations

A good PR:

  • Explains what changed and why
  • Includes relevant context or screenshots (for UI changes)
  • Avoids unrelated formatting or refactors
  • Passes existing checks

Small, incremental PRs are easier to review and more likely to be merged quickly

Reporting Bugs

When reporting a bug, please include:

  • What you expected to happen
  • What actually happened
  • Steps to reproduce
  • OS and Node.js version (if relevant)
  • Any error messages or logs

License

By contributing, you agree that your contributions will be licensed under the Apache License 2.0, the same license as this project.

Code of Conduct

Be respectful and constructive. Harassment, discrimination, or unprofessional behavior will not be tolerated.

Thanks again for contributing — every improvement helps make ObservAgent better for everyone. ❤️