The way commit messages are written is important too, so that we know and understand what the commit is about. It should be written in English. Example like:
- Add a button that creates a game
- Added Support for Platform
- [Fix] Player spawns spam bug
- MPTransformSync: Added Lerp
(For full class names, they can be shortened into their abbreviations, such as MultiPlayCore -> MPC, MPPlayer -> MPP, MPTransformSync -> TransformSync)
If possible, please split big commits into separate pull requests. This makes reviewing much easier. If codes were dependent on each other, you can cherry-pick the commit first.
If you encounter a bug while using the library, you can fill out the issues here.
You can annotate API documentation with GDScript's annotation. Check this out for more info on how to use them.
Generating pages for API documentation is usually done after each version. The guide will be addressed later
The documentation runs in hugo. If you want to run the page, you'll need to install hugo first. Docs content uses markdown, HTML content is not supported. However, you can use shortcodes.
Documentation Repository lives here
When a new version is released. The repository owner (maji) will update the commit hash at the Godot Asset Library system. To make sure the new download gets the latest version.
Deployment is also done at mpc-deploy. The purpose is for faster deployment because Godot AssetLib moderation does take time, and can be slow for hot fixes, etc. This is used in MPC's built-in update checker.
When a new version is released, release-info.json will update, pointing the commit hash/download URL to that new version's commit.
Contributors can discuss in hi maji! Discord Server It's where discussion about MultiPlay Core usually happens.