1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
|
# Contributing to mediafile
First off, thanks for taking the time to contribute! ❤️
Please follow these guidelines to ensure a smooth contribution process.
## Pre-requisites
- Python 3.10 or higher
- Git
## Setup the Development Environment
We recommend using a virtual environment to manage dependencies. You can use `venv`, `conda`, or any other tool of your choice.
1. Fork/Clone the repository on GitHub
```bash
$ git clone <your-fork-url>
$ cd mediafile
```
2. Set up your development environment
```bash
$ python -m pip install --user pipx
$ pipx install poetry poethepoet
```
3. Install project dependencies
```bash
$ poetry install
```
## Before submitting a Pull Request
Verify that your code adheres to the project standards and conventions. Run
ruff and pytest to ensure your code is properly formatted and all tests pass.
```bash
$ poe lint
$ poe format
$ poe test
```
|