Join the growing Backdrop contributor community at https://github.com/backdrop-contrib.
To apply, create a request as an issue in this queue: https://github.com/backdrop-ops/contrib/issues/new
If you have started writing or porting a project for Backdrop, please include a
link to the module, theme, or layout. If you have posted the code under your
own GitHub account you will be able to easily transfer the entire repository
to live under https://github.com/backdrop-contrib/[your_project_name]
after
joining the Backdrop Contributed Project Group.
Benefits of joining:
Requirements to join:
Rejected applications:
All projects must meet these minimum requirements.
By joining the Backdrop Contributed Project Group (Backdrop Contrib, for short) you agree to the following:
You will not push changes to a repository for which you are not a current maintainer (even though joining the Backdrop Contrib group will grant you access to push to any project within).
You must agree to license your code contributions as GPLv2 or later.
Any project you create or maintain must include a copy of the GPL-2.0
LICENSE.txt
file
in the root of your repository. The GPLv2 license applies to all code that
directly interacts with parts of Backdrop licensed as GPLv2 or later. See the
Backdrop License FAQ for a more detailed
explanation.
You must confirm that you have the right to distribute any additional code, libraries, images, fonts or other assets written or created by any third party with code licensed as GPLv2 or later.
Any project you create or maintain must include a README.md
file containing
at the least the following:
You may use this example README.md to get started.
You will work with the Backdrop Security Team to address any vulnerabilities in any project you create or maintain, if necessary.
Any project you create or maintain will have the GitHub issue tracker enabled for official communication.
If any of the above requirements are not met, your access to the Backdrop Contrib group -- including all projects and even those that you may have originally authored -- may be revoked.
If your project becomes abandoned and you do not respond to an issue to grant a new maintainer within 2 weeks, your project may be modified by a Backdrop Contrib Administrator to add a new maintainer, without your explicit consent.
If an applicant is not (yet) a coder but would still like access to the contrib group (for example, for updating documentation or managing issue queues) the applicant must get at least one recommendation from another person who already has commit access to the contrib group.
Any non-coder applicant still agrees to the same contributed project author agreement as coders (above).
Any non-coder applicant needs to additionally promise that should they ever wish to author new code in the Backdrop contrib group, they will also undergo the same code spot-check process a new contributor needs to undergo at the time they add the code.
When you are ready:
Clean up your code so it's ready for community collaboration.
If you started your project with a title like "backdrop-port-of-xyz", change the name of the project to exactly match the Drupal project (e.g. "xyz").
Transfer the project to the backdrop-contrib organization following the steps mentioned in this post.
If your repository has a 'master' branch, you'll need to create a new '1.x-1.x' branch to replace it:
git checkout master
git pull origin master
git checkout -b 1.x-1.x
git push origin 1.x-1.x
git push origin --delete master
Make sure you are subscribed to notifications for the project's issues. The GitHub issue queue is where all the communication for your project happens, and when new issues are created, you need to know about them and respond in a timely manner otherwise your project might be considered abandoned following the procedure listed below.
If your project is a port of a Drupal project, it is a best practice to subscribe to the issue queue on drupal.org. That way you can be updated when issues are fixed. You can then decide if you want any of those commits in your project. Similarly, if you fix bugs or or add new features, please consider letting the maintainer(s) of the original project know about it. It would be even better to post a patch in the Drupal queue for them to review. If you have found a security issue that applies to both, please try to coordinate the release of the fix with the maintainers of the original project through non-public channels so that potential attackers do not take advantage of either Backdrop or Drupal sites.
The module, theme and layout releases on Backdropcms.org rely on GitHub releases. Before creating a GitHub release, you must first add git tag. The format for the tag should be "1.x-1.0.0". "1.x-1.0.0-alpha1" or "1.x-1.0.0--beta1" can also be used to indicate a project is not yet stable and should be used with caution.
The most common order of operations is as follows:
git tag 1.x-1.0.0
If successful, your project should appear on the modules, themes or layouts listing pages on BackdropCMS.org.
If there was an error during the packaging process, an error message from the packager will be attached instead.
You will need to work with the Backdrop Security Team in order to make a security release for your project. Please contact security@backdropcms.org to begin this process. Please see the Security Release Documentation for more details.
You may apply to adopt an abandoned project. The procedure is as follows:
If you haven't already, please join the Backdrop Contrib group by submitting an application (see above).
File an issue with the current project requesting to help maintain the project.
After confirming the project has been abandoned, a Backdrop Contrib administrator will add your name to the list of maintainers in that project's README.md file.
You may now maintain the project directly as though given permission by the project maintainers, and likewise now grant permission to others to maintain the project.