Development Guide

Welcome to the FatPy development guide. This section provides resources to help you contribute to the FatPy project effectively.

Getting Started

If you're new to FatPy development, we recommend starting with these resources:

• Installation Guide - Set up your development environment
• Contributing Guide - Learn how to contribute to the project
• Code of Conduct - Understand our community standards

Development Resources

• Code Style - Coding standards and style guidelines
• Documentation - Documentation best practices and guidelines
• Testing - How to write and run tests
• CI/CD Process - Information about our continuous integration workflow

Project Structure

For a detailed overview of the project structure, see the API Reference.

Development Workflow

Following Test-Driven Development (TDD) principles:

1. Write tests first - Define the expected behavior before implementing
2. Set up your environment - Follow the installation guide
3. Create a feature branch - git checkout -b feature-name
4. Implement the feature - Follow the code style guide
5. Run and refine tests - See the testing guide
6. Document your changes - Update the documentation
7. Submit a pull request - See the contributing guide

Getting Help

If you encounter issues or need assistance with development, you can:

• Create an issue in the GitHub repository
• Contact the maintainers at jan.vyborny2@gmail.com

Thank you for contributing to FatPy!