First off, thank you for considering contributing to Plexir! It's people like you that make Plexir such a great tool.
By participating in this project, you are expected to uphold our Code of Conduct.
- Check if it has already been reported by searching through GitHub issues.
- Provide a clear and concise description of the bug.
- Include steps to reproduce the behavior.
- Mention your environment (OS, Python version, Docker version).
- Open a Feature Request issue.
- Explain why this enhancement would be useful to most Plexir users.
- Fork the repository and create your branch from
main. - If you've added code that should be tested, add tests.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that PR!
- We use Black for code formatting.
- Follow PEP 8 conventions.
- Use descriptive variable and function names.
- Keep functions small and focused on a single task.
- Clone your fork:
git clone https://github.com/YOUR_USERNAME/plexir.git cd plexir - Create a virtual environment:
python -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate
- Install dependencies and the package in editable mode:
pip install -r requirements.txt pip install -e . - Run tests (if applicable):
pytest
If you have questions, feel free to open an issue or reach out to the maintainers.