CONTRIBUTING.md

How to contribute to xPore

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.

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.

• Before submitting, please read the PEP 8 – Style Guide for Python Code to know more about coding conventions used in xPore.

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

• Suggest your change in the Discussions (ideas)

• Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.

Do you have questions about the source code, publication, or use cases of xPore?

• Ask any question about how to use xPore, where to find data sets, or possible extensions in the Discussions (Q&A).

Have you used xPore and was it helpful for your research?

• Let us and the community know how you used xPore! You can post a summary with links to a preprint or manuscript in the Discussions (show and tell)

Thanks! ❤️ ❤️ ❤️

the xPore team

Attribution

These community contribution guidelines are adapted from Ruby on Rails contribution guidelines available at https://github.com/rails/rails/blob/main/CONTRIBUTING.md