Contributing to Econometron

Thank you for your interest in contributing to Econometron! We welcome all contributions, whether they are new features, improvements, or bug fixes. Following the guidelines below helps us maintain code quality and consistency.

How to Contribute

1. Fork the Repository
   Create your own fork of the repository to work on changes safely.

2. Create a Branch
   Use a descriptive branch name:

   git checkout -b update#<number>-<short-description>
   git checkout -b fix#<number>-<short-description>

3. Make Changes

   • Update code, documentation, or tests.
   • Follow existing code style and structure.
   • Keep commits clear and concise.

4. Test Your Changes Ensure that all existing tests pass and add new tests if necessary.

5. Submit a Pull Request (PR)

   • Provide a clear title and description for your PR.
   • Reference the update or fix number if applicable.

Update / Fix Format

• Updates

  (update#<number> - <optional short description>)

  Example: (update#12 - Added VARMA echelon form identification example)

• Fixes

  (fix#<number> - <optional short description>)

  Example: (fix#3 - Corrected error in IRF local projection computation)

Coding Style

• Follow PEP8 conventions for Python code.
• Document all functions, classes, and modules with docstrings.
• Use meaningful variable and function names.

We appreciate your contributions and your help in improving Econometron!