Driving the usage of standalone modules

To drive usage of your standalone modules, we recommend covering the following points.

Provide installation instructions

Provide complete, accurate and up-to-date installation instructions in README. For an example of installation instructions, see Install the Data Exchange API.

Make sure each section contains a verification step that clearly explains how to verify the changes are implemented correctly. After completing all the steps of an installation guide, for end users, the functionality should work as expected.

Support users

Set up a support portal or use GitHub issues to enable users to collaborate with you on problems and bugs. Include the instructions for submitting issues in your README. Make sure to mention any domain-specific details needed from a user to identify the issue.

Provide migration instructions

If a module has multiple major releases, provide a migration guide for each of them. For an exmple of a migration guide, see Upgrade the CategoryGUI module. Make sure each section contains a verification step that clearly explains how to verify the changes are implemented correctly. After completing all the steps of an installation guide, for end users, the functionality should work as expected.

For more details about major releases, see Semantic Versioning.

Next step

Publish modules on Packagist