Skip to content

Commit

Permalink
docs: include setup and formatting steps
Browse files Browse the repository at this point in the history
  • Loading branch information
ranebrown authored and redstreet committed Mar 23, 2024
1 parent 3d4a6e9 commit b5f2855
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Contributing

Contributions welcome. Preferably:
- include a test file. I realize this is sometimes a pain to create, but there is no way
for me to test external contributions without test files
Expand All @@ -18,3 +20,30 @@ Contributions welcome. Preferably:
         ├── History_for_Account_X8YYYYYYY.csv
         └── run_test.bash
```

## Setup

Development setup would typically look something like this:

```bash
# clone repo, cd to repo

# create virtual environment
python3 -m venv venv

# activate virtual environment
source venv/bin/activate

# install dependencies
pip install -e .[dev]
```

## Formatting

Prior to finalizing a pull request make sure to run the formatting tools and
commit any resulting changes.

```bash
ruff format
isort --profile black .
```

0 comments on commit b5f2855

Please sign in to comment.