Skip to main content

🤝 Contributing to Awesome ACTUS Library

Thank you for your interest in improving the Awesome ACTUS Library!
This project is designed to support ACTUS contract simulation, visualization, and analysis using a modern, extensible Python codebase.

We welcome contributions of all kinds — from code improvements and documentation fixes to entirely new components.

🛠 Repository​

This library is hosted on GitHub:

GitHub: maierdon/awesome-actus-library

🧪 How to Contribute​

1. Fork the Repository​

Create your own copy of the repository by clicking the "Fork" button on GitHub.

2. Make Changes​

  • Use clear and consistent coding style (we follow standard Python best practices)
  • Add or update docstrings if you're modifying functionality
  • Include a short design comment if you're introducing new modules

3. Submit a Pull Request​

Once your changes are ready, create a pull request (PR) from your forked branch to the main branch of this repository.

A maintainer will review your PR and provide feedback or merge it in.

📄 Design Contributions​

If you'd like to contribute or access design documents or blueprints (e.g., new analysis classes, contract types, or risk factor integrations):

  • Create a dedicated folder or markdown file in a design_docs/ directory
  • Clearly describe the motivation, proposed structure, and intended use
  • Contact the owner for access to design documents like class diagrams use cases etc.

📬 Contact​

If you're unsure how to proceed or want to suggest larger changes, reach out directly to the project maintainer:

  • GitHub Username: maierdon
  • Email: (to be added)

🔗 External Resources​

Thank you again for helping build a better open-source financial simulation platform!