Guide
1
Fork & clone the repository
- Go to the OpenGB modules repository
- Click the “Fork” button in the top right to create a copy of the repo in your own GitHub account
- Clone your forked repo locally (more info)
2
Add your module
-
Add your module code under a new folder for your module under the
modules/
directory.g.modules/my_module
. For example: -
Commit your changes using Conventional Commits
- Include the module name in parenthesis after the commit message, e.g.
feat(my_module): add new script
- Include the module name in parenthesis after the commit message, e.g.
- Push your changes to your forked repo (more info)
3
Open a pull request
Open a pull request against the upstream
rivet-gg/opengb-modules
repo (see GitHub’s guide on creating a pull request)Release Checklist
Before publishing your module, make sure your module passes all the required checks:- All tests pass (
opengb test
) - All required metadata are filled out in the
module.json
:status
: The status of the modulename
: The human readable name of the moduledescription
: A short description of the moduleicon
: The Font Awesome icon name of the moduletags
: The tags associated with this moduleauthors
: The GitHub handle of the authors of the moduleerrors
: The errors associated with this module (required)- See module config for more details
- All exposed scripts have names & descriptions
- Custom errors thrown by the module have names and descriptions