Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (24 loc) · 895 Bytes

CONTRIBUTING.md

File metadata and controls

35 lines (24 loc) · 895 Bytes

Contributing

Thank you for your interest in contributing to GlobalRoot.

Quick Start

  1. Fork the repository.
  2. Create a branch from main.
  3. Make focused changes with clear commit messages.
  4. Run basic checks before opening a pull request:
python -m compileall -q .
  1. Open a pull request using the template.

Guidelines

  • Keep changes small and reviewable.
  • Do not include secrets in code or commits.
  • Keep user-facing text in English.
  • Update docs when behavior changes.
  • Prefer backward-compatible changes unless a breaking change is explicitly discussed.

Pull Request Checklist

  • Code compiles and runs for the changed area.
  • README/docs are updated when needed.
  • Risky behavior changes are clearly documented.
  • Security-sensitive changes include a short rationale.

Reporting Issues

Use the issue templates for bug reports and feature requests.