Contributing to the PyXplor package

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. Your input and support are essential in making this tool more effective and user-friendly.

Types of Contributions

Report Bugs

If you are reporting a bug or have a feature request, please help us by opening an issue in our GitHub repository, tagged with the label “bug”, and include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Submit Feedback

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.

Get Started!

Ready to contribute? Here’s how to set up pyxplor for local development.

Download a copy of pyxplor locally.
Install pyxplor using poetry:
```
$ poetry install
```
Use git (or similar) to create a branch for local development and make your changes:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
When you’re done making changes, check that your changes conform to any code formatting requirements and pass any tests.
Commit your changes and open a pull request.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

The pull request should include additional tests if appropriate.
If the pull request adds functionality, the docs should be updated.
The pull request should work for all currently supported operating systems and versions of Python.

We aim to review pull requests within 7 days. Your contributions will be checked for adherence to our coding standards and overall quality.

Code of Conduct

Please note that the pyxplor project is released with a Code of Conduct. By contributing to this project you agree to abide by its terms.