Addon Submission

We encourage anyone with the skills and the time available to develop non-bundled addons and themes for Composr. By doing so, you enable others to further extend their Composr sites with features not covered by the core developers. And you get a bit of coding experience in the process!

To submit your addon, click here to Contact Us, choose Other (free services), and choose "Submit a non-bundled addon or theme".

Why should I submit to the official repository?

While it is entirely optional, getting your addon or theme accepted into the repository means that it will be easily downloadable from any Composr site's Admin Zone and from the composr.app site (more visibility). Additionally, although you will be responsible for maintaining the addon, the core developers will ensure it continues to function on a very basic / core level between Composr versions. And finally, you will receive points as a reward.

Guidelines

When submitting an addon or theme for inclusion in the official repository of non-bundled addons / themes, please consider the following:
  • Your code is expected to adhere to the latest PHP coding standards. As of this writing, it is PSR-12. Consider reviewing our tutorial on programming and our coding primer.
  • Your code is expected to adhere to the Composr coding standards; it doesn't have to be perfect but it must follow basic practices at minimum.
  • Have a look on our tutorial for building addons (also go to "see also" for parts 2 and 3).
  • Consider using the export addon tool in the Admin Zone (can also be used for themes). This is the best way to archive your addon and submit it to the core team as it is already packaged in such a way other Composr sites can install it.
  • Please read the Points / Rubric section and each tab before submitting your addon. That way, you will have an idea of some of the criteria the core team looks for in accepting addons.

Points / Rubric

To encourage high-quality and useful addons / themes in the official repository, core developers use a rubric as outlined below for judging whether an addon / theme gets accepted into the Composr non-bundled addons repository, and how many points you receive as a reward. These points are assigned an appropriate role which could also list you on the community stars page.


The addon or theme will be rejected, and either the member encouraged to fix their addon / theme and re-submit again, or to share the addon / theme in the forum instead, if any of the following conditions hold true:
  • The addon / theme is too niche and would not be useful for a vast majority of sites.
  • The addon / theme does not add any useful features or reinvents the wheel on something that does not need to be reinvented.
  • The developers do not believe the addon / theme aligns with the current philosophy / direction of Composr.
  • The addon / theme does not work, contains any major bugs or security issues, breaks anything else in Composr, or contains any minor bugs the developers believe should have been easily spotted and fixed.
  • The addon / theme has significant UI / UX issues.
  • The addon / theme contains poor grammar and/or spelling.
  • The addon / theme is very slow or inefficient.
  • The addon / theme does not pass our automated tests (we may allow a few exceptions, and in a few other cases we may fix it ourselves).
  • The code does not adhere to basic PHP or Composr coding standards (we allow some leniency for non-bundled addons but we still expect they conform to basic standards).
  • Your addon / theme's licence agreement is not compatible with that of Composr's licence (e.g. we do not accept closed-source or proprietary addons or themes)

Please do not be discouraged if the team does not accept your addon into the official directory. That does not necessarily mean it is a bad addon. It could be, for example, that the addon does not follow the current vision of Composr. Members are always welcome to share their awesome themes and addons in the forums. And if an addon is rejected because it does not meet standards, you can work on it so that it does, and then re-submit it. Also don't hesitate to ask others in the community for support.







In addition to the above, you will also receive points when someone likes the addon. Members can individually send you points as a thank-you for the addon. And you will get points when you regularly maintain and update the addon / theme.