40 lines (31 loc) · 1.1 KB

Contributing to Filebin.py

First off, thanks for taking the time to contribute! 🎉

Development Setup

Fork and Clone the repository.
Install dependencies (in a virtual environment):
```
pip install -e ".[dev]"
```

Workflow

Branching: Create a feature branch from main.
Code Style: We use ruff to enforce code quality and formatting.
- Before committing, format and lint your code:
```
ruff check Filebin/ tests/ --fix
```
Testing: Ensure all tests pass.
- Run offline unit tests:
```
pytest -m "not network"
```
- Run full integration tests (requires network access):
```
pytest
```
Commit Messages: Write clear, concise commit messages.

Pull Requests

Submit a PR against the main branch.
The CI workflow will automatically run ruff and the offline unit tests.
Once the CI passes and the PR is approved, it will be merged.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.