Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (27 loc) · 2.11 KB

CONTRIBUTING.md

File metadata and controls

45 lines (27 loc) · 2.11 KB
Raw

Contributing to Genesis

Thank you for your interest in contributing to Genesis! We're excited to have you involved.

Contributor License Agreement (CLA)

All contributors must sign an Individual Contributor License Agreement (CLA) before we can accept any contributions.

We use a CLA assistant bot to streamline this process. When you open your first pull request, the CLA assistant will automatically check whether you've signed the agreement and guide you through the process if you haven't. It's quick and only needs to be done once.

The CLA ensures that the project remains sustainably licensed under the AGPL-3.0 and that the community can confidently build on everyone's work.

What the CLA covers

  • You affirm that you own the code you're contributing and have the right to license it under the project's license.
  • You grant the project the right to use and distribute your contribution under the AGPL-3.0 license.
  • You retain full ownership of your contribution — you're not giving away your copyright.

How to Contribute

  1. Fork the repository and create your branch from main.
  2. Make your changes — follow the existing code style and conventions.
  3. Run the pre-commit checks — mix precommit (formats code and runs tests).
  4. Write or update tests to cover your changes.
  5. Open a pull request — the CLA assistant will verify your CLA status, and CI will run the test suite.

Development Setup

See the Run from source section in the README for environment setup instructions.

Code Style

  • This is an Elixir project — run mix format to keep code consistently formatted.
  • Keep files focused and reasonably sized (around 1,000 lines is a soft threshold before considering a split).
  • Follow the conventions established in the codebase.

Commit Messages

Write clear, descriptive commit messages. The project maintains a clean Git history as part of its evolutionary architecture.

Questions?

If you have questions about the CLA or the contribution process, feel free to open an issue or start a discussion.

We appreciate your contributions! 🎉