Skip to content

Contributing

CommonGraph is a community-driven, open source project. We welcome contributions!

Ways to Contribute

  • Use it — Deploy CommonGraph for your community and share your experience
  • Report bugs — Found an issue? Open a GitHub issue
  • Suggest features — Have ideas? Start a discussion
  • Improve documentation — Help make these docs clearer
  • Submit code — Fix bugs or implement features
  • Share configurations — Contribute example schemas for different use cases

Getting Started

For Developers

  1. Clone the repository
  2. Follow Development Setup guide
  3. Explore the codebase
  4. Run tests to familiarise yourself
  5. Pick an issue or feature to work on

For Documentation

  • Documentation lives in /docs (these pages)
  • Submit edits via pull request
  • Follow the structure and style of existing docs

Development Workflow

  1. Create a branch: git checkout -b feature/your-feature-name
  2. Make changes and test locally
  3. Commit with clear messages
  4. Push to your fork
  5. Open a pull request with description

Code Standards

See Development for code style and testing guidelines.

Reporting Issues

When reporting bugs, please include: - Steps to reproduce - Expected behaviour - Actual behaviour - Environment (OS, Python version, etc.)

Licensing

By contributing, you agree that your contributions are licenced under the GNU AGPL (same as the project).

Questions?

Thank you for contributing!