Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (19 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 1.01 KB
Raw

Contributing to Forail Platform

This repository is the canonical home of the full contributing guide for the whole Forail Platform project — git workflow, commit conventions, coding standards, PR process across all repos.

Read first: docs/10-contributing-guide.md

What lives here

  • Docker Compose deployment stack (production and development overlays)
  • Install scripts and bootstrap
  • Cross-repo documentation (architecture, deployment, ops, contributing)
  • Release notes for the platform as a whole

Quick start (deploy stack)

git clone https://github.com/forail-platform/forail-devops.git
cd forail-devops
cp .env.example .env
docker compose up -d

See README.md and docs/ for full setup.

Reporting bugs

Open an issue with reproduction steps, expected vs. actual behavior, and your environment (Docker version, host OS, Forail version).

For security vulnerabilities, see SECURITY.md — please do not open a public issue.