🛠️ Contributing Guide

We welcome contributions to the AbacatePay SDK! Follow the steps below to get started.

✅ Prerequisites

Clone your fork locally Replace your-username with your GitHub username:

git clone https://github.com/your-username/abacatepay.git
cd abacatepay

Set up the virtual environment using Poetry

If you don’t have Poetry installed, follow the instructions here.
```
poetry install
```
Install pre-commit hooks To ensure consistent code quality during development, we use pre-commit hooks.
```
poetry run pre-commit install
```
Create a new branch for your changes Use a descriptive name for the feature or fix:
```
git checkout -b feature-name
```
Run the tests to ensure nothing is broken:
```
poetry run task test
```
Check code style and formatting The test command will also check code style using Ruff. If formatting issues remain, you can fix them manually:
```
poetry run task lint
poetry run task fmt
```
Don't forget to document your changes We use MKDocs for documentation. We also use MKDocStrings to generate reference documentation from docstrings, so make sure to properly document your functions and modules.

Commit and push your changes

git add .
git commit -m "Add feature or fix: short description"
git push origin feature-name

☕ That’s it! Grab a coffee while we review your contribution. Thanks for helping improve AbacatePay SDK! 🙌