audit-labs/tutorials

 1# Contributing to audit-labs/tutorials
 2
 3Thanks for your interest in contributing! Contributions can include new tutorial notebooks, improvements to existing notebooks, documentation, CI improvements, and environment files.
 4
 5Recommended workflow
 61. Fork the repository.
 72. Create a feature branch: `git checkout -b feature/your-feature`.
 83. Make your changes (keep each notebook focused and add explanatory markdown).
 94. If adding dependencies, update `environment.yml` and `requirements.txt`.
105. Run notebooks locally and ensure they execute (or add tests / CI changes).
116. Commit with descriptive messages and open a pull request describing your changes.
12
13Coding / notebook guidelines
14- Keep notebooks self-contained and add a top-level markdown header explaining purpose.
15- Avoid embedding large, proprietary datasets; include links or small sample data.
16- Use `nbstripout` or `pre-commit` if you want to strip outputs before committing (optional).
17- When changing dependencies, mention version rationale in the PR description.
18
19If you're unsure about scope, open an issue first to discuss the plan.