How to contribute
The full onboarding guide (joining GitLab, environment setup, Cursor AI, merge request flow) is the Contributing page in this documentation site.
Dev environment scripts
| Platform | Script |
|---|---|
| Linux / macOS | scripts/setup-dev.sh |
| Windows | scripts/setup-dev.ps1 |
Checks Python 3.11+, creates .venv, installs [dev] + pre-commit hooks, runs ruff and
pytest unless skipped; optional glab install (--install-glab) with confirmation.
Shared bash helpers:
scripts/setup-dev-common.sh.
Quick links
| Step | Document |
|---|---|
SSH keys and git@gitlab-ai:libesys/esysdox-ops.git | GitLab SSH keys |
| First push and first pipeline | GitLab getting started |
Working branch develop and CI | GitLab CI |
Commit messages and AI: footer | Commit messages |
| Pre-commit checklist | Commit checklist |
glab install, auth, CI logs (optional) | GitLab CI agent access |
| Python package release | Package release |
| Release pipeline | Release pipeline |
| Release hygiene | Release hygiene |
| Roadmap to 1.0.0 | Roadmap to 1.0.0 |
| Agent architecture | instructions.md |
Edit the narrative guide in website/docs/contributing.md only — avoid copying long
sections here so there is a single source of truth.