From PHPBB用户手册

Revision: MOD.003.2007.3
smithy_dll

The phpBB Modifications Team has a number of requirements and policies regarding the phpBB.com modifications database (MODDB). They are summarised in the 10 points below.

1. English must be used as the primary language
   The phpBB Group requires English to be World English (`en` phpBB, and thusly MODX also)
   The primary language is to be included in the main (root) MODX file
   `en-gb` is considered equal to `en` and may be used in place (for the lang attribute only), where `en` is preferred
2. prosilver must be used as the primary template
   1. Both proSilver and subSilver templates may be used.
   2. No template changes are to be made in the main (root) MODX file. All template changes are to be placed in /templates as described in the MODX packaging format specifications.
3. Do not include pre-mod files
   1. This is inclusive of the contrib directory
4. Use the phpBB3.0 coding standards for PHP and HTML
5. Contain no security holes or concerns
   “A security concern is the use of insecure coding practices that may or may not contain a valid security hole.”
6. Use MODX packaging standards
   1. Where a phrase in the MODX specification is more lenient than this document, this document is to be referenced.
7. Use phpBB versioning scheme
8. Support a minimum of PHP4.3.3
9. Support all databases phpBB3.0 supports
   1. Use the phpBB DBAL
   2. For table creation mySQL syntax suffices in the SQL command
   3. Installation scripts must supports all databases phpBB3.0 supports
   4. phpBB Modifications Team may use any database phpBB3.0 supports to test any submitted MOD
   5. Do not use the MODX SQL command `type` labels, leave as undefined for mySQL
10. Be a stable release
    1. Refer to phpBB versioning scheme

That is all, 10 simple requirements for good coding practices when writing phpBB3.0 MDOs and the requirements for successful submission to the phpBB.com modifications database.

Full requirements and conditions

The phpBB.com modifications database offers a service of validation and distribution of community created modifications for the phpBB web application. Below is the full set of requirements and conditions for the phpBB.com modifications database.

The phpBB Modifications Team reserved the right to remove any modification from the database at any time with no warning given to the author. In general the modifications team will not exercise this right unless:

1. It has come to the attention of the phpBB Modifications team that the MOD contains a security vulnerability that was not identified during the validation process.
2. The author of the modification is banned from participating in the phpBB.com community.
3. The phpBB Modifications Team may from time-to-time purge MODs that no-longer currently work with the latest stable release of phpBB

While the phpBB Modifications Team makes every effort to ensure modifications released into the MODDB are free from bugs and security vulnerabilities, it is possible that some from time-to-time escape the attention of the phpBB Modifications Team and makes it into the MODDB.

Modifications must not disable any security features present in phpBB including but not limited to:

1. The captcha feature, unless being replaced by a different one
2. The update check

Modifications must make use of standard security features of phpBB including using the new request_var() function instead of $HTTP_*_VARS or $_* as per the phpBB3.0 coding standards.

Modifications that include source code from phpBB in the distribution are legally required to be licensed under the GPL. Modifications that do not legally require licensing under the GPL may be licensed as the author sees fit. When submitting to the phpBB.com MODDB the author gives phpBB.com the right to distribute the modification indefinitely with no restrictions. The phpBB Modifications Team will not sell your MOD, the only method of distribution available is free distribution. The phpBB Modifications Team recommends licensing MODs under the GPL or LGPL in the same spirit of phpBB.

Modifications must make use of the .MODS ACP module where an additional ACP is added unless it otherwise makes sense to place it elsewhere. Creating a new top level module should always be a last resort measure.

Code that is not formatted appropriately may be rejected from the MODDB at the discretion of the phpBB Modifications Team even if it meets all other requirements.

Modifications must support PHP4.3.3. Modifications may use other requirements and PHP modules if they explicitly state any further requirements phpBB does not require in the author notes section of the installation file.

Modifications must not include PHP in template files, either cosmetic or to perform function.

It is the responsibility of the author of a modification to test the modification before submitting to the phpBB.com MODDB. If the phpBB Modifications Team thinks that a modification has not been tested at all or appropriately it may be instantly denied from the MODDB until the phpBB Modifications Team thinks that the modification has been tested appropriately.

Modifications must use the MODX packaging guidelines, in this case the target application is phpBB. In addition, the following optional requirements are required by the phpBB Modifications Team:

1. A license file must be included
2. Primary target version is “3.0” except for release candidates which are "3.0.RC1" etc...
3. Modifications must not exclude future revisions/releases from installing the MOD
4. The latest World English prosilver style sheet must be accompanied as the style sheet with submitted MODs. At time of writing this is v1.4.
   The modification author may make minor cosmetic changes to this style sheet, but it must be kept up to date with the official one. Cosmetic means edits to the CSS; the behaviour, copyright notice, and language used must not be altered.

Where this document is in conflict with the MODX packaging guidelines, this document is to be referenced as the correct specification. Any field marked as required in the MODX specification is required for a MODX file to pass through an XML file validator against the MODX XSD. The current version of MODX to be used is version 1.0.

Modifications that no-longer work with the latest revision/release of phpBB may from time-to-time be purged from the MODDB. The phpBB Modifications Team will notify authors thirty (30) days prior to the purge through board announcements on phpBB.com.

Once a modification has been submitted to the MODDB the phpBB Modifications Team may retain copied of the modification indefinitely even if a modification is not approved or is removed from the phpBB.com MODDB.

Modification authors may not resubmit an unchanged modification to the phpBB.com MODDB when a new revision/release of phpBB is released just to update the compatible version listing. Changing the targetversion in the MODX file is not considered a change under this condition.

Modification authors are urged to give functions, variables, and classes names unique to their modification to minimise the chance of clashing with another modification. If a function, variable, or class name is too generic, (e.g. ‘stuff’ or ‘mod’) the phpBB Modification Team reserves the right to deny the modification from publication in the MODDB until the functions and/or classes are given more meaningful names relevant to the modification under validation. For example if a calendar modification were to be written, a function could be named: calendar_today() instead of just today(). Organising functions into classes are a great way to avoid clashes.

It is the responsibility of authors to check announcements for any changes to the phpBB.com MODDB requirements and conditions and any other news such as an upcoming purge.

Each modification may only have one (1) release topic in the phpBB.com MODDB.

While the phpBB Modifications Team aims to release, a modification submitted to the phpBB.com MODDB in less than two weeks, due to the volunteer status of the team we are unable to provide guaranteed validation turn-around times, or estimate the time until a modification is approved/denied.

The phpBB Modifications Team uses a process called insta-deny™ to increase the turn-around on MODs that require small changes before being accepted to the modifications database. If a modification fails the instadeny ™ criteria it will be denied within the first 24 hours since being submitted. If a modification fails insta-deny™ and is not looked at within the first 24 hours a formal validation will be performed and a formal validation report produced which may take longer. The phpBB Modifications team will not contact you if your modification passes insta-deny™ and moves onto the next phase of validation. The phpBB Modifications team is unable to guarantee any validation periods.

Periods of heavy modification submitting may delay MODs from being validated further such as just after a new release. Modification authors are advised to be patient during these times of heavy work loads for the phpBB Modifications Team.

The phpBB Modifications Team reserves the right to update and change these requirements at any time without notice.