First of all, thank you for taking the time to contribute to this project! Magpie follows the All Contributors specification. No matter in what form you contributed to the project (e.g. code, document, test, etc.), the developer will add you to the contributors list as long as you contributed enough.
FAQ includes most of the common questions asked. You can also search in Issues and Discussions to see if anyone has raised the same question before. Feel free to go ahead and ask in Discussions if not.
First, please search through Issues and Discussions to make sure the same problem has not already been reported. When reporting a bug, please create an Issue (bug report). Here are some best practices to help the developers to quickly locate the error:
- Choose a clear and concise title. For example, "The rounded corner of windows in Windows 11 causes the top-left and bottom-right corners to be blurry" is a good title. "Application Error," on the other hand, is hard to interpret.
- Uploading log files is especially helpful for troubleshooting. They can be found in the logs folder. Please upload the logs as attachments rather than copying their content into the issue description.
- Describe the steps to reproduce the issue in detail, and include screenshots whenever possible.
- Other information may also be helpful, such as unusual monitor configurations, GPU models, and other relevant system details.
First, search through existing Issues to make sure your suggestion has not already been proposed. Then submit an Issue (feature request) with a detailed description of your idea, including whether other software already implements a similar feature.
If you'd like to suggest a new effect, please clearly describe its name, use cases, and any existing shader implementations (if exists). It is also highly recommended to include comparison screenshots with existing effects.
Like all open-source projects, you need to submit a pull request to contribute code to Magpie. Pull requests should be submitted against the dev branch.
Please note: by contributing code to Magpie, you agree to transfer the copyright of that code to the current copyright holder of Magpie. This allows developers to make important decisions (like changing the license) without getting consent from every single contributor. The developers promise that the only changes in license will be shifting to newer versions of GPL.
Please do not contribute code that is directly generated by AI. You should fully understand the code you contribute.
We are using Weblate for localization work. If you'd like to help translate Magpie into more languages, please visit https://hosted.weblate.org/projects/magpie.
The Magpie wiki is automatically published from the docs folder, so modifying documentation follows the same process as contributing code