Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (43 loc) · 3.91 KB

CONTRIBUTING.md

File metadata and controls

65 lines (43 loc) · 3.91 KB
Raw

Contributing to CodeZero

Thank you for your interest in contributing to CodeZero! We are happy about every contribution, whether it is a bug report, a new feature, a plugin, or improved documentation.

Where does my contribution belong?

This repository is the release repository. It contains the official releases, the Docker Compose setup, and the product README. The actual source code of CodeZero lives in separate repositories inside the code0-tech organization.

Please open issues and pull requests in the repository that matches your topic:

Repository What it is
sculptor The web frontend where you build flows and manage projects
sagittarius The backend that orchestrates data, users, and flows
aquila The runtime gateway that keeps your flows updated
taurus The runtime that executes your flows
draco Flow triggers such as HTTP/webhook and cron
velorum The AI orchestrator that generates and edits flows
hercules The Action SDK for building your own plugins
centaurus The central place for all actions
pictor The base UI component library
tucana The gRPC interface library between all services
telescopium The documentation published at docs.codezero.build

If you are not sure where your topic belongs, just open an issue here or ask on Discord. We will point you to the right place.

Contributing to this repository

Contributions here are welcome for:

  • The README and product presentation
  • Images and other assets
  • Problems with the Docker Compose setup

Please note: the compose file and the .env template are updated automatically by our release tooling. If you spot a problem with them, open an issue first so we can fix it at the source.

Reporting bugs

  1. Check the existing issues in the matching repository to avoid duplicates.
  2. Describe what you did, what you expected, and what happened instead.
  3. Include your setup where relevant, for example the release tag (IMAGE_TAG in your .env), your operating system, and relevant logs from docker compose logs.

Suggesting features

Feature ideas are always welcome. Open an issue in the matching repository and describe the problem you want to solve, not only the solution you have in mind. If you want to discuss an idea first, the Discord is the fastest way to reach the team.

Pull requests

  1. Fork the repository you want to contribute to and create a branch for your change.
  2. Keep pull requests focused. One topic per pull request makes reviews faster.
  3. Write a clear description of what your change does and why.
  4. Please write issues, pull requests, and code comments in English.

Building plugins

You can extend CodeZero without touching any core repository. Plugins (actions) add new nodes, flow types, and triggers to a runtime. The hercules Action SDK is the starting point, and the documentation covers the details.

Community

Be respectful and constructive. We want CodeZero to be a welcoming project for everyone. Our Code of Conduct applies to all community spaces.

  • 💜 Discord: ask questions and talk to the team
  • 📚 Docs: guides and reference documentation

Thank you for helping to make CodeZero better!