Environment & Development
Prerequisites
Environment Setup
Local Environment
- Clone repository
git clone https://github.com/jakepenzak/caml
- Change directory (cd) into project root then create your pixi environments:
pixi install
pixi install --environment dev
pixi install --environment dev-polars
pixi install --environment dev-pandas
pixi install --environment dev-pyspark
- Activate you pixi shell for dev environment
pixi shell --environment dev
Initialize pre-commit hooks via
pre-commit install
Edit & test code locally (as applicable)
Please refer to the pixi documentation for modifying dependencies and any other pixi related questions.
Committing & Pull Requests
- Try best to follow commit message conventions outlined here
- On PRs, please fill out the generated PR template. As of now, there are two github actions that will be triggered on pull request & will be required to run successfully in order to merge:
- CI/CD pipeline (
.github/workflows/ci.yml
) through dev & tst environments (see Running bundle job via Github Actions for more details) - Testing & updating coverage badge (
.github/workflows/testing.yml
)
- CI/CD pipeline (