First, thank you for considering contributing to Py2Exe. Your help is essential for keeping it great. Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project.
We welcome contributions in several forms, including bug reports, feature suggestions, and pull requests.
A well-written bug report is a significant contribution. Please ensure your report includes the following:
- Clear Title: A descriptive title that identifies the issue.
- System Information: Your operating system, Python version, and PySide6 version.
- Steps to Reproduce: A clear, step-by-step list of actions to trigger the bug.
- Expected Behavior: What you expected to happen.
- Actual Behavior: What actually happened.
- Log Output: Copy and paste any relevant output from the build log, especially error messages.
Please submit bug reports as GitHub Issues.
If you have an idea for a new feature or an improvement to an existing one, please open an issue with a clear description:
- What is the problem? Explain the context and why the enhancement is needed.
- What is your proposed solution? Describe the feature and how it would work from a user's perspective.
- Are there any alternatives? Discuss any other solutions you've considered.
- Fork the repository and create your branch from
main. - Make your changes. Ensure your code adheres to the existing style and structure.
- Do not alter unrelated code. Your pull request should be focused on a single bug fix or feature.
- Test your changes thoroughly. Ensure that your modifications do not break any existing functionality.
- Write clear commit messages. Follow a consistent format (e.g.,
Feat: Add UPX version detection,Fix: Correct log panel resizing). - Submit the pull request. Provide a clear description of the problem and your solution. Link to any relevant issues.
Your pull request will be reviewed by the maintainer. You may be asked to make changes before it can be merged.
Thank you for your contribution!