Thank you for helping build Aura — a multidisciplinary research hub. This guide explains how to contribute safely and consistently.
- Fork the repo and create a branch named
feature/<short-description>. - Update code, add tests (pytest), and update
schema/aura_schema.yamlif sheets/columns change. - Run tests locally:
pytest -q. - Open a Pull Request to
mainwith a clear description and link to any related issue.
- The canonical schema is
schema/aura_schema.yaml. If you add/rename columns or sheets, update this file and incrementschema_version. - For breaking schema changes, create
schema/aura_schema_v2.yamland add migration notes todocs/schema-migrations.md.
- Never commit real personal data. Use synthetic or anonymized example data only.
- Follow privacy laws and research ethics. Document consent and anonymization procedures in
Ethics_Notes.
- Add tests for functionality you change. CI will run pytest on pushes and PRs.
- Python: follow PEP8. Keep functions small and documented.
- Use type hints where helpful.
Open an issue and tag @maintainers or post on the project discussion board.