How to contribute
I am personally super grateful you're interested in contributing to Godot WRY. No contribution is too small, and all help is valued.
Technical contributions
Report bugs & issues
Found something broken? Let us know!
- Check the open issues to make sure it's not already reported.
- Use the report bug template to create a new issue.
- Steps to reproduce the problem are a must have for other people to be able to see and debug your issue, so please include them!
Contribute code
NOTE
It's always a good idea to create an issue with your suggestions before submitting a PR. If an issue already exists, please comment your interest on working on it to avoid double work.
IMPORTANT
Always make sure the documentation is up to date with your changes, especially if your changes affect the API. For that, you can check Writing documentation.
- Fork the repo & clone it locally.
- Build the project and test it manually to make sure everything works.
- Create a branch with a descriptive name:bash
git checkout -b fix-webview-crash - Make your changes.
- Submit a PR with a clear description of what you did.
You can work on any open issues you want, especially ones tagged with help wanted or good first issue.
Review code
Code reviews are just as valuable as writing code!
- Help catching bugs before merging.
- Suggest performance/code improvements.
- Ask questions when something isn't clear (this helps documentation)!
- Share knowledge with other contributors.
You can add yours comments, insights and suggestions to any open PRs you feel confident reviewing. If you're not familiar with reviewing code, GitLab's What is a code review? is a great place to start.
Demo projects
Examples help everyone understand how to use the project and demo what Godot WRY is capable of.
The examples live in the "godot/addons/godot_wry/examples" folder. They can be focused on demonstrating a specific feature or a use case for Godot WRY.
If you're insterested in building a demo project:
- Try to keep it small.
- Add it to the documentation with a clear writeup of what and how it's doing what it's doing.
- If the demo you want to make is too complex or out of scope, you can also share a link for a separate repo and we can figure it out.
Documentation
Good docs is very important so developers can actually use and contribute to Godot WRY. You can check out the Writing documentation guide for more info on that.
Community support
Answer issues
Helping users is incredibly valuable. If you have any bits of knowledge to share that can help figuring out any open issues, please do! Even if you can't solve a problem completely, partial answers still help!
Join the Discord
He have a shared Discord for webview development. There you can ask/answer questions, share what you are building, get to know other contributors, discuss ideas and future plans, and whatever else you want!
Create tutorials/content
Blog posts, YouTube tutorials or documentation guides that can help others to use Godot WRY are always welcome!
Donations
Godot WRY is 100% free and open source. We don't take donations, but you if this project helps you, consider supporting the maintainers directly.
Thank you!
Remember, every contribution matters! Whether it's code, documentation, bug reports, or literally just using Godot WRY and being part of the community. Thanks for making this project better! 💕🫶✨