All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. The community looks forward to your contributions. 🎉

• Reporting Bugs
  • Before Submitting a Bug Report
  • How Do I Submit a Good Bug Report?
• Suggesting Enhancements
  • Before Submitting an Enhancement
  • How Do I Submit a Good Enhancement Suggestion?
• Code Contribution

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

• Make sure that you are using the latest version.

• Determine if your bug is really a bug and not an error on your side.

• Check the currently working on section to see if we are already working on this bug.

• To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.

• Collect information about the bug:

  • Stack trace (Traceback)
  • OS, Python version
  • Can you reliably reproduce the issue?

Bugs are tracked as GitHub issues. If you run into an issue with the project:

• Open an Issue. (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
• Explain the behavior you would expect and the actual behavior.
• Please provide as much context as possible and provide a minimal, reproducible example that someone else can run to recreate the issue on their own. Please don't paste your full code, but rather the shortest possible example.
• Provide the information you collected in the previous section.

This section guides you through submitting an enhancement suggestion for MPGLite, including completely new features and minor improvements to existing functionality.

• Make sure that you are using the latest version.
• Check the currently working on section to see if we are already working on this functionality.
• Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.

Enhancement suggestions are tracked as GitHub issues.

• Use a clear and descriptive title for the issue to identify the suggestion.

• Provide a step-by-step description of the suggested enhancement in as many details as possible.

• Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.

• Explain why this enhancement would be useful to most users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

If you want to contribute code to MPGLite, please follow these steps to ensure a smooth integration:

1. Fork the Repository: Create your own copy of the project on GitHub.
2. Clone the Project: Download your fork to your local machine.
3. Make Changes: Implement your feature or bug fix.
4. Test Your Changes:
5. Commit & Push: Commit your changes with a clear message and push them to your fork.
6. Submit a Pull Request (PR): Open a PR against our main branch. Describe your changes and link any related issues.