Contributing to Clipette

Bug fixes, feature additions, tests, documentation and more can be contributed via issues and/or pull requests. All contributions are welcome.

Bug fixes, feature additions, etc.

Please send a pull request to the main branch. Please include documentation for new features. Tests or documentation without bug fixes or feature additions are welcome too. Feel free to ask questions via issues or discussions.

• Fork the Clipette repository.
• Create a branch from main.
• Develop bug fixes, features, tests, etc.
• Make sure to test your updates prior to creating a pull request.
• Create a pull request to pull the changes from your branch to the Clipette main.

Guidelines

• Separate code commits from reformatting commits.
• Follow PEP 8.
• Include Documentation within the code in docstrings near definitions as needed or appropriate with your bug fixes, feature additions and tests.
• Documentation docstrings within code must follow Sphinx docstring style.

Reporting Issues

When reporting issues, please include code that reproduces the issue and whenever possible, an image that demonstrates the issue. Please upload images to GitHub, not to third-party file hosting sites. If necessary, add the image to a zip or tar archive.

Provide details

• What did you do?
• What did you expect to happen?
• What actually happened?
• What versions of Windows, Clipette and Python are you using?