Contributing

Contributions to the Cats API are welcome! This guide outlines how to contribute.

Getting Started

1. Fork the Repository: Fork Maclovi/pure-architecture-fastapi.

2. Clone Your Fork:

   git clone https://github.com/<your_username>/pure-architecture-fastapi
   cd pure-architecture-fastapi
   python3 -m venv .venv
   source .venv/bin/activate
   

3. Set Up Development:

   just bootstrap
   

Making Changes

Create a Branch:

git checkout -b feature/your-feature

Follow Coding Standards:

• Use Ruff for linting (just lint).
• Run static analysis (just static).
• Write tests (just test).

Commit Messages: Use conventional commits (enforced by conventional-pre-commit):

• Example: feat: add new cat endpoint
• Types: feat, fix, docs, chore, style, refactor, test, build.

Run Pre-Commit Hooks:

pre-commit run --all-files

Submitting Changes

Push Changes:

git push origin feature/your-feature

Create a Pull Request:

• Target the develop branch.
• Describe the changes and reference any issues.

CI Checks: The PR will trigger pr-tests.yaml to run tests and linters. Ensure all checks pass.

Code Review

• Respond to feedback promptly.
• Make necessary changes and push updates to the same branch.

Issues

Report bugs or suggest features via GitHub Issues.

Contact

• Author: Sergey Yavorsky (GitHub)
• Email: maclovi.dev@gmail.com

Thank you for contributing!