1. Contributing

We welcome anyone to assist in developing and maintaining Bfrescox packages. Before contributing, please read the following guidelines. We especially welcome contributions extending functionality for parsing different Frescox output files.

1.1. Code style and documentation

  • Follow the PEP 8 style guide for Python code.

  • Use clear and descriptive names for variables, functions, and classes.

  • Write docstrings for all public functions, classes, and methods, including parameter and return type descriptions.

  • Use Sphinx-compatible reStructuredText for documentation.

  • Use type hints where appropriate to improve code readability and maintainability.

1.2. Git Workflow

  • Fork the repository and create a new branch for your feature or bug fix.

  • Commit your changes with clear and descriptive messages.

  • Push your changes to your forked repository.

  • Create a pull request to the main repository, describing your changes and the problem they solve.

  • Ensure your code passes all tests and adheres to the project’s coding standards before submitting a pull request.

1.3. Testing

  • Add unit tests to the test suite for any new functionality or bug fixes.