How to Publish Your Contributed Theme or Module on Drupal.org

How to Publish Your Contributed Theme or Module on Drupal.org
Contributing to the Drupal community by publishing your theme or module on Drupal.org is a rewarding experience. It allows you to share your work, gain recognition, and help others enhance their Drupal projects. Here’s a step-by-step guide to get started.

1. Prepare Your Code

Before you can publish, ensure your theme or module is production-ready. Follow Drupal’s coding standards and include:

  • A README.md file describing your theme/module.

  • A valid .info.yml file.

  • Properly organized code with meaningful comments.

2. Create a Drupal.org Account

If you don’t already have one, register on Drupal.org. Make sure to complete your profile and add a profile picture to demonstrate your credibility within the community.

3. Submit a Project Application

  1. To create a Theme project, go to Create Theme Project.

  2. To create a Module project, go to Create Module Project.

  3. Fill in all required fields:

    • Name: A descriptive name for your project.

    • Project type: Choose whether it’s a Theme or Module.

    • Short name: A machine-readable name for the project.

    • Maintenance status: Indicate if the project is actively maintained.

    • Development status: Specify if it’s in development or production-ready.

4. Comply with Licensing

Ensure all code, assets, and libraries comply with GPLv2 or later. Avoid using non-compatible assets. For third-party libraries, confirm their licenses are compatible with GPL.

5. Review and Feedback

Once submitted, your project will undergo a community review. Here’s how to navigate it:

  • Respond to feedback promptly.

  • Update your project to address issues.

  • Be patient; reviews may take some time.

6. Request Maintainer Permissions

After passing the initial review, you can request Git repository access to maintain your project. This involves:

  • Following Git instructions provided on Drupal.org.

  • Using version control to manage updates.

7. Push Your Code to Drupal.org

Set up a local Git repository and push your code to the Drupal.org repository using the provided SSH URL. Follow Drupal’s Git documentation for detailed steps.

8. Publish and Promote

Once your project is live:

  • Share it on social media platforms.

  • Write a blog post or create documentation to guide users.

  • Engage with the community by answering questions and gathering feedback.

9. Additional Resources

For more detailed instructions on publishing your theme or module, refer to the official documentation: How to Publish a Project on Drupal.org.

10. Maintain Your Project

  • Regularly update your project to support new Drupal versions.

  • Fix bugs and respond to feature requests.

  • Monitor the issue queue to assist users.

Publishing your first theme or module may seem daunting, but it’s a fulfilling journey. By contributing, you’re not just sharing your work; you’re enriching the Drupal ecosystem and becoming part of a global community.

Post a Comment

Previous Post Next Post