Contributing

We welcome contributions to the Proteus Actuarial Library!

How to Contribute

  1. Fork the repository on GitHub

  2. Clone your fork locally

  3. Create a new branch for your feature or bugfix

  4. Make your changes and add tests

  5. Run the test suite to ensure everything passes

  6. Commit your changes with clear commit messages

  7. Push to your fork and submit a pull request

Development Setup

See the Development Guide guide for detailed instructions on setting up your development environment.

Code Style

  • Follow PEP 8 style guidelines

  • Write clear, descriptive docstrings

  • Add type hints to function signatures

  • Write tests for new functionality

Reporting Issues

Please report issues on our GitHub issue tracker.

When reporting issues, please include:

  • A clear description of the problem

  • Steps to reproduce the issue

  • Expected behavior vs. actual behavior

  • Your Python version and PAL version

  • Any relevant code snippets or error messages