- Issue created by @ruby232
- ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น
Thank you for applying!
Please read Review process for security advisory coverage: What to expect โ for more details and Security advisory coverage application checklist โ to understand what reviewers look for. Tips for ensuring a smooth review โ gives some hints for a smoother review.
The important notes are the following.
- If you have not done it yet, enable GitLab CI for the project, and fix what reported from the phpcs job. This help to fix most of what reviewers would report.
- For the time this application is open, only your commits are allowed. No other people, including other maintainers/co-maintainers can make commits.
- The purpose of this application is giving you a new drupal.org role that allows you to opt projects into security advisory coverage, either projects you already created, or projects you will create. The project status won't be changed by this application.
- Nobody else will get the permission to opt projects into security advisory policy. If there are other maintainers/co-maintainers who will to get that permission, they need to apply with a different module.
- We only accept an application per user. If you change your mind about the project to use for this application, or it is necessary to use a different project for the application, please update the issue summary with the link to the correct project and the issue title with the project name and the branch to review.
To the reviewers
Please read How to review security advisory coverage applications โ , Application workflow โ , What to cover in an application review โ , and Tools to use for reviews โ .
The important notes are the following.
- It is preferable to wait for a Code Review Administrator before commenting on newly created applications. Code Review Administrators will do some preliminary checks that are necessary before any change on the project files is suggested.
- Reviewers should show the output of a CLI tool โ only once per application. The configuration used for these tools needs to be the same configuration used by GitLab CI, stored in the GitLab Templates repository.
- It may be best to have the applicant fix things before further review.
For new reviewers, I would also suggest to first read In which way the issue queue for coverage applications is different from other project queues โ .
- ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น
- The following points are just a start and don't necessarily encompass all of the changes that may be necessary
- A specific point may just be an example and may apply in other places
- A review is about code that does not follow the coding standards, contains possible security issue, or does not correctly use the Drupal API
- The single review points are not ordered, not even by importance
src/ConfigImport.php
$message = 'The import failed due to the following reasons:' . "\n"; $message .= implode("\n", $config_importer->getErrors()); $this->logger()->error($message);
The
$message
parameter passed to theLoggerInterface
methods must be a literal string that uses placeholders. It's not a translatable string returned fromt()
or$this->t()
, a string concatenation, nor a value returned from a function/method. - ๐ฎ๐ณIndia vishal.kadam Mumbai
1. FILE: Readme.md
README.md file is missing the required sections โ - Requirements, Installation and Configuration.
2. FILE: src/Commands/DevutilsCommands.php
/** * DrushDevutilsCommands constructor. * * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager * The entity type manager service. * @param \Drupal\file\FileUsage\DatabaseFileUsageBackend $fileUsage * Service database file usage backend. */ public function __construct(
FILE: src/Commands/DrushDevutilsCommands.php
/** * DrushDevutilsCommands constructor. * * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager * The entity type manager service. * @param \Drupal\file\FileUsage\DatabaseFileUsageBackend $fileUsage * Service database file usage backend. */ public function __construct(
The documentation comment for constructors is not mandatory anymore, If it is given, the description must be โConstructs a new [class name] objectโ, where [class name] includes the class namespace.
- ๐บ๐พUruguay ruby232 Montevideo
Thanks for the feedback. I've implemented the changes and pushed them.
- ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น
$message = $this->t( 'The import failed due to the following reasons:\n @reasons', ['@reasons' => implode("\n", $config_importer->getErrors())]); $this->logger()->error($message);
The first argument passed to error() needs to be a literal string which uses placeholders, not a translatable string.
- ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น
Thank you for your contribution and for your patience with the review process!
I am going to update your account so you can opt into security advisory coverage any project you create, including the projects you already created.
These are some recommended readings to help you with maintainership:
- Dries โ ' post on Responsible maintainers
- Maintainership โ
- Git version control system โ
- Issue procedures and etiquette โ
- Maintaining and responding to issues for a project โ
- Release naming conventions โ .
You can find more contributors chatting on Slack โ or IRC โ in #drupal-contribute. So, come hang out and stay involved โ !
Anyone is welcome to participate in the review process. Please consider reviewing other projects that are pending review โ . I encourage you to learn more about that process and join the group of reviewers.I thank the dedicated reviewers as well.