Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (30 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 1.14 KB
Raw

Contributing to RouteForge

Setup

git clone https://github.com/DeepZone/routeforge.git
cd routeforge
cp .env.example .env
docker compose up --build

Backend Tests

cd backend
pytest -q

Frontend Build

cd frontend
npm run build

Pull Request Guidelines

  • Keep pull requests focused and easy to review.
  • Update documentation together with user-facing behavior changes.
  • Add or update tests when behavior changes.
  • Do not break existing API endpoints without explicit versioning and migration notes.

Read-only safety principle

RouteForge is read-only by design.

Do not add write operations without explicit design discussion

Do not add write operations (registry writes, ROA creation, router deployment, or similar mutating workflows) without an explicit design discussion and maintainer approval.

License of contributions

By contributing to RouteForge, you agree that your contributions are licensed under the same license as the project: GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later).

Do not contribute code that you do not have the right to license under AGPL-3.0-or-later.