Contributing¶

First off, thank you for considering contributing to Fantasy Football AI! It's people like you that make this project great.

Code of Conduct¶

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior.

Getting Started¶

To get started, you'll need to have the following installed:

Once you have the prerequisites installed, you can set up your development environment:

task bootstrap

This will create a virtual environment and install all the necessary dependencies.

Development¶

To get started with development, you can use the bootstrap task to set up your environment:

task bootstrap

This will create a virtual environment and install all the necessary dependencies.

Before submitting a pull request, please ensure that your code is well-tested and follows the existing code style. You can run the following tasks to help you with this:

task lint: Lints the code with flake8.
task format: Formats the code using ruff.
task test: Runs the test suite.
Write Unit Tests: For any new features or bug fixes, please include corresponding unit tests to ensure correctness and prevent regressions.

Submitting a Pull Request¶

When submitting a pull request, please ensure that your code is well-tested and follows the existing code style.

Fork the repository: Fork the project to your own GitHub account.
Create a new branch: Create a new branch for your changes.
```
git checkout -b feat/my-awesome-feature
```
Make your changes: Make your changes to the codebase.
Run the tests: Run the test suite to ensure that your changes don't break anything.
```
task test
```
Lint and format your code: Ensure that your code follows the existing code style.
```
task lint
task format
```
Commit your changes: Commit your changes with a descriptive commit message.
```
git commit -m "feat: add my awesome feature"
```
Push your changes: Push your changes to your fork.
```
git push origin feat/my-awesome-feature
```
Open a pull request: Open a pull request from your fork to the main repository.

Style Guide¶

This project follows the PEP 8 style guide for Python code. We use ruff to enforce this style guide.

Commit messages should follow the Conventional Commits specification.

Agent Guidelines¶

This project utilizes AI agents, and their behavior and output are governed by specific guidelines defined in the AGENTS.md files located throughout the repository. These files ensure consistent and effective interaction with the AI. For more information, refer to the main AGENTS.md document.

Questions¶

If you have any questions, feel free to open an issue.