Development Guide¶

This section provides comprehensive resources to help you contribute to FatPy, a Python package for fatigue life evaluation of materials, part of the FABER project.

Learn About FABER

About

FatPy emphasizes code quality, thorough documentation, and rigorous testing. Whether you're fixing bugs or adding features, this guide will help you become a successful contributor.

Getting Started¶

New to FatPy? Start with these resources to set up your environment and understand how to contribute effectively:

Installation Guide
Set up your development environment for FatPy.
Contributing Guide
Learn how to contribute code, documentation, or ideas to the project.
Code of Conduct
Understand our community standards for respectful collaboration.

Development Resources¶

Deepen your understanding of FatPy development with these resources:

Code Style
Follow our coding standards for consistent, high-quality code.
Documentation
Learn best practices for writing and maintaining FatPy documentation.
Testing
Understand how to write and run tests to ensure code reliability.
CI/CD Process
Explore our continuous integration and deployment workflow.

Additional resources

Join our GitHub Discussions for community support.
Find contribution ideas in our GitHub Issues.

Get a detailed overview of FatPy’s modules and functions, visit API Reference.

Development Workflow¶

Follow our development workflow:

Set Up Your Environment
Installation Guide
Create a Feature Branch
```
git checkout -b feature-name
```
Implement the Feature
Follow the Code Style Guide.
Write and Run Tests
Testing Guide
Document your Changes
Use Documentation resources!
Submit a pull request
Contributing Guide

Getting Help¶

Need assistance with FatPy development? Reach out through these channels:

GitHub Discussions
Join for community support.
Report an Issue
Create an issue on our GitHub repository for bugs or questions.
Contact our Team
Visit our contact page.

Thank you for contributing to FatPy!