Contributing Guide

How to contribute to Your Unified Reader

Did you find a bug?

• Ensure the bug was not already reported by searching on GitHub under Issues.

• If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

• If possible, use the bug report template to create the issue.

Did you write a patch that fixes a bug?

• Open a new GitHub pull request with the patch.

• Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Do you intend to add a new feature or change an existing one?

• Suggest your change using the feature request tempelate and start writing code.

• Make sure you write appropriate documentation (we use Google Docstrings) and corresponding tests (using pytest).

Do you have questions about the source code?

• Ask any question about how to use your here.

Your is a volunteer effort. We encourage you to pitch in and join the team!

Thanks!

Your Team