Contributing¶
Thank you for reading this. Maintaining this template is vital to ensuring it remains relevant and allows the community to produce high quality, reproducible projects. The information below should get you started. If you have questions, please ask a maintainer.
Resources¶
- This template is inspired by the Cookiecutter Data Science template.
- Copier Docs
- Quarto Docs
What to Work On¶
- Check the repository issues for open items.
- If the bug or feature you want to work on does not have an open issue, open one first.
- Work on what makes your life easier. If you are not interested in the work, it probably will not be of much value to anyone.
Development Setup¶
Clone the Repository¶
git clone https://github.com/PatternLabs-XYZ/CopierDataScience.git
cd CopierDataScience
Create a Feature Branch¶
git checkout -b feature/descriptive-name
Dev Container¶
This repo includes a .devcontainer spec. If you have VS Code and Docker installed, use the VS Code Remote Containers plugin to spin up a fully configured development environment. The plugin reads the .devcontainer configuration and builds the Docker container locally.
Local Development¶
Run the following to install dependencies and set up pre-commit hooks:
just install
Commit Guidelines¶
Conventional Commits¶
Changes merged to the main branch trigger a CI pipeline that bumps version numbers, tags the commit, and creates a GitHub release via python-semantic-release. Commit messages are parsed using the Angular method, so following the Conventional Commits format is required.
Each commit message should be structured as:
<type>(<scope>): <description>
[optional body]
[optional footer]
Where:
<type>is the kind of change (feat,fix,docs,style,refactor,test,chore)<scope>is the area affected (optional)<description>is a concise summary of the change
Examples¶
feat(data): add new data loading function
fix(model): correct prediction function issue
docs(readme): update installation instructions
refactor(utils): simplify error handling
Pull Request Process¶
- Create a PR from your feature branch to
main. - Describe your changes — what is the purpose, what changed, how was it tested.
- Link relevant issues using keywords (
Fixes #123,Relates to #456). - Request review from at least one team member.
- Address feedback and update as needed.
- Squash and merge once approved.
PRs should be atomic: one feature or fix per PR. Commit messages should be concise but capture the full scope of the change.
Code Standards¶
- pre-commit runs checks before each commit.
- Ruff handles linting and formatting.
Testing¶
- Write tests for non-trivial new code. Tests for existing code are always welcome.
- pytest is the testing framework.
pytest