Skip to content

Commit

Permalink
Add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cclauss committed Sep 5, 2024
1 parent dea7683 commit 147c146
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
All community interactions should be aligned with our Code of Conduct.

We appreciate your interest in this project and look forward to collaborating around
respecful issues and pull requests.

To isolate this project from other projects that use Python, we encourage you to create
a [`venv`](https://docs.python.org/3/library/venv.html) with the commands:
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install --editable .
```

We use [`pre-commit`][https://pre-commit.com/] to format, lint, and test files in this
project so we strongly encourage coontributors to:
# `pipx install pre-commit` or `brew install pre-commit`
# Then in the project root directory run `pre-commit install`

This project requires that a current version of `Docker Desktop` is properly installed.
3 changes: 3 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# CONTRIBUTING
```{include} ../CONTRIBUTING.md
```

0 comments on commit 147c146

Please sign in to comment.