Skip to content

Contributing to CloudRader

Open Source Community-Driven Modular Standards Welcoming Culture

Thank you for your interest in contributing to CloudRader! CloudRader is an open-source initiative built by and for communities, organizations, and teams who believe in self-hostable, modular infrastructure.

We welcome contributions of all forms: writing code, fixing bugs, authoring documentation, refining user interfaces, reporting issues, and suggesting architectural enhancements.

Explore the Contributing Guides

  • Development Standards

    Core technology standards, Python/FastAPI backend conventions, TypeScript frontend requirements, code formatting with Ruff, and commit message rules.

  • Contribution Workflow

    Step-by-step contribution lifecycle: repository forking, branch naming, local development setup, pre-commit validation, and pull request submission.

Ways to Contribute

You do not need to be an expert systems architect or core maintainer to get involved:

  • Code & Core Enhancements

    Implement new features, optimize database queries, fix bugs, or expand REST API endpoints across our backend and frontend services.

  • Documentation & Guides

    Clarify existing guides, fix typographical errors, write self-hosting deployment recipes, or add troubleshooting walkthroughs.

  • Issue Reporting & Triage

    Test pre-releases, report reproducible bugs with log outputs, confirm edge cases, and provide feedback on planned roadmap features.

  • Design & Accessibility

    Improve user interface responsiveness on mobile web browsers, enhance color contrast, refine navigation flows, and polish iconography.

Contribution Lifecycle

All contributions across CloudRader repositories follow a transparent, peer-reviewed workflow:

flowchart LR
    Find["Find Issue<br/>or Propose Feature"] --> Branch["Fork & Create<br/>Feature Branch"]
    Branch --> Code["Develop & Format<br/>(Ruff / TypeScript)"]
    Code --> Check["Validate Locally<br/>(make check)"]
    Check --> PR["Submit Pull Request<br/>(Conventional Commits)"]
    PR --> Review["Automated CI<br/>& Maintainer Review"]
    Review --> Merge["Merged into<br/>main Branch"]
  1. Find or Propose: Select an existing issue labeled good first issue or help wanted, or propose an enhancement via a GitHub issue.
  2. Fork & Branch: Create an isolated, descriptive branch on your personal fork (feat/my-feature or fix/issue-description).
  3. Develop & Verify: Write clean, typed code backed by tests and run local checks (make check) before pushing.
  4. Review & Merge: Submit a pull request with a Conventional Commit title. Continuous integration validates the build, followed by maintainer review.

Community Code of Conduct

We are dedicated to providing a friendly, safe, and welcoming environment for everyone, regardless of experience level, background, or identity.

Community Values

  • Be Respectful: Treat all contributors and community members with kindness, empathy, and professional courtesy.
  • Constructive Feedback: Offer and receive critique constructively. Focus on the code, architecture, and documentation rather than individuals.
  • Supportive Collaboration: Welcome newcomers, answer questions patiently, and help one another build reliable open-source tooling.

Project Repositories

Explore the core repositories in the CloudRader ecosystem:

Repository Description Primary Languages Source Code
CloudRader/docs Central organization documentation site Markdown, Python, Zensical GitHub
CloudRader/reservium-api Room and space reservation backend Python, FastAPI, SQLAlchemy GitHub
CloudRader/reservium-ui Web UI application for Reservium TypeScript, React, Tailwind CSS GitHub
CloudRader/inventarium-api Asset and equipment tracking service Kotlin, Spring Boot, PostgreSQL GitHub