Contributing to Failprint

We welcome contributions to make Failprint better! Before you start, please take a moment to review the guidelines below.

Steps to Contribute

Fork the repo and create a new branch from main.
- Always create a branch for each feature or bug fix.
Write tests for any new functionality you add.
- Make sure your code is thoroughly tested.
Ensure the tests pass by running pytest (or your preferred test framework).
- Make sure your code adheres to the project's coding standards.
First raise an issue and wait for it to be assigned.Then only create a Pull Request (PR) when you’re ready to submit your changes.
- Provide a detailed description of what the PR does, and include relevant issue references (if any).

To ensure that all code in the project is consistent, please follow these coding style guidelines:

Indentation: Use spaces for indentation. No tabs.
Naming: Use descriptive names for functions, variables, and classes.
Documentation: Comment your code where necessary and add docstrings for functions and classes.

Please use clear, concise commit messages that describe the purpose of the change.

By contributing, you agree that your contributions will be licensed under the BSD-2-Clause License.

If you find any issues, please open an issue on the repository so that we can address it.

Thank you for your interest in contributing to Failprint! We appreciate your effort to make this project better.