Contributing

We welcome contributions to Eolic! Here are some guidelines to help you get started.

Setting Up Your Environment

1. Fork the repository on GitHub.
2. Clone your fork to your local machine:

   git clone https://github.com/your-username/eolic.git

3. Navigate to the project directory:

   cd eolic

4. Install the required dependencies:

   poetry install

Coding Style

We follow the PEP 8 coding style guide. Please make sure your code adheres to this standard.

Pre-Commit Hooks

We use pre-commit hooks to ensure code quality. Install the pre-commit hooks with:

pre-commit install

Submitting a Pull Request

1. Create a new branch for your feature or bug fix:

   git checkout -b my-feature-branch

2. Make your changes.
3. Commit your changes:

   git commit -m "Description of my feature"

4. Push your branch to your fork on GitHub:

   git push origin my-feature-branch

5. Open a pull request on GitHub.