Application workflow
Before reviewing applications, please see Tools to use for reviews.
Workflow and status changes
An application whose status is Active isn't reviewed; we allow the user who created the application to tell us to wait to review the project used for the application. The only status used for requesting a review is Needs review.
It is important that a project moderator checks the project used for the application before any code review is started. Telling the applicant what to change in the project files, and then telling the applicant (for example) the application is not necessary because the permission to opt projects into security has been already given, or the project does not match the criteria used to select which projects can be used for these applications, would not be a positive experience for people who apply.
The Needs work status should be reserved for major (high priority) issues or for the first review. Holding up reviews for minor issues can come off as unnecessary and nit-picky, especially early in the review process. This can also cause frustratingly long waits for uninitiated applicants.
The workflow for applying to security advisory coverage is the following.
-
Once the application has been created, a project moderator will verify:
- The applicant cannot already opt projects into security advisory coverage.
- The applicant has not already created an application which is still open.
- The project used for the application contains enough PHP code and it has commits from the applicant, at least in the branch used for the application.
- The license file eventually present is not for a license that is different from the one used from Drupal core.
- When applicants have fully prepared their code and supporting materials, they should change the issue status to Needs review.
- Reviewers will then review the project. If they don't find any flaw or problem with the code, they set the status to Reviewed & tested by the community. It is preferable not doing that on the first review, and that another reviewer confirms there is no flaw or problem with the code before setting the status to Reviewed & tested by the community.
- If there's a problem, or a clarification is needed after review, the question should be asked, and the reviewer should change the status to Needs work.
- If project moderators need more information, they change the status to Postponed (maintainer needs more info).
- The status will alternate between Needs review and Needs work until a conclusion is reached.
- When a reviewer is confident that the application can be approved, a status change to Reviewed & tested by the community will inform the project moderators who will do a final review and set the status to Fixed upon approval or bump it back to Needs work if there are still changes required.
- The status of applications that are not appropriate for whatever reason is changed to Closed (won't fix).
- Applications whose status is Needs work a year after they have been created, and whose priority has been Low for at least six months, will be closed as Closed (won't fix). Applicants can still re-open them, if they are willing to continue the application and they changed what the review suggested to change.
The priorities used in the security coverage applications, what they mean, and when they are changed is described in the Issue priorities page.
Templates for feedback and notifications used in the process are available in the Template for reviewers. Those are a sub-set of the templates used by project moderators.
Examples of issues that warrant going back to Needs work
- Creating a form outputting HTML markup instead of using the form API
- Not sanitizing user input that is shown in a page or using the wrong function/method to sanitize user input
- Concatenating strings to build the query string instead of using database query placeholders
- Not using placeholders for translatable strings, especially when the string is built on user input
- Not translating strings when they should be, or translating them when they should not be
- Not checking the access to pages, or using the wrong permission to allow access to pages
- Including third-party code
- Sloppy formatting and not following the Drupal coding standards
Examples of changes that should not block the application
These are examples of changes that should not block the application, except in the case the review is the first review done or there are other changes that should be done.
Furthermore, if a previous review asked for these changes, but the project files have not been changed to reflect them, a new review can still ask for these changes.
- Changing the README.txt or the README.md file to make each line shorter than 81 characters
- Implementing
hook_help() - Fix small, occasional, formatting errors
Help improve this page
You can:
- Log in, click Edit, and edit this page
- Log in, click Discuss, update the Page status value, and suggest an improvement
- Log in and create a Documentation issue with your suggestion