- Issue created by @alexismmd
- ๐ฎ๐ณIndia vishal.kadam Mumbai
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, you should run
phpcs --standard=Drupal,DrupalPractice
on the project, which alone fixes most of what reviewers would report. - For the time this application is open, only your commits are allowed.
- 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 and no other user will be able to opt projects into security advisory policy.
- 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.
- 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 โ .
- If you have not done it yet, you should run
- ๐จ๐ญSwitzerland nadja_stu
Fix the following phpcs warnings and errors:
phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,yml multisite_manager_tool/ FILE: \multisite_manager_tool\multisite_manager_tool.module -------------------------------------------------------------------------------- FOUND 12 ERRORS AFFECTING 10 LINES -------------------------------------------------------------------------------- 1 | ERROR | [x] Missing file doc comment 10 | ERROR | [x] Missing function doc comment 11 | ERROR | [x] Line indented incorrectly; expected 2 spaces, found 4 12 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 8 13 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 8 14 | ERROR | [x] Line indented incorrectly; expected 6 spaces, found 10 15 | ERROR | [x] Line indented incorrectly; expected 6 spaces, found 10 16 | ERROR | [x] Line indented incorrectly; expected 6 spaces, found 10 18 | ERROR | [x] Line indented incorrectly; expected 2 spaces, found 6 18 | ERROR | [x] Closing brace indented incorrectly; expected 4 spaces, found | | 6 19 | ERROR | [x] Line indented incorrectly; expected 0 spaces, found 1 19 | ERROR | [x] Closing brace indented incorrectly; expected 0 spaces, found | | 1 -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 12 MARKED SNIFF VIOLATIONS AUTOMATICALLY 18 | ERROR | [x] Closing brace indented incorrectly; expected 4 spaces, found | | 6 19 | ERROR | [x] Line indented incorrectly; expected 0 spaces, found 1 19 | ERROR | [x] Closing brace indented incorrectly; expected 0 spaces, found | | 1 -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 12 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: \multisite_manager_tool.permissions.yml -------------------------------------------------------------------------------- FOUND 1 ERROR AFFECTING 1 LINE -------------------------------------------------------------------------------- 9 | ERROR | [x] Expected 1 newline at end of file; 2 found -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: \multisite_manager_tool\src\SitesHelper.php -------------------------------------------------------------------------------- FOUND 5 ERRORS AFFECTING 4 LINES -------------------------------------------------------------------------------- 116 | ERROR | [x] Line indented incorrectly; expected 10 spaces, found 8 116 | ERROR | [x] Object operator not indented correctly; expected 10 spaces | | but found 8 117 | ERROR | [x] Line indented incorrectly; expected 10 spaces, found 8 118 | ERROR | [x] Whitespace found at end of line 119 | ERROR | [x] Whitespace found at end of line -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 5 MARKED SNIFF VIOLATIONS AUTOMATICALLY --------------------------------------------------------------------------------
- ๐ช๐ธSpain alexismmd
Hello @nadja_stu,
I have already fix the problems with coding standards.
Thank you very much for your review.
- ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น
The tag can be added after reviewing three different project applications whose status is Needs review. That is not a manual review, so it does not count for the review bonus.
- ๐ฎ๐ณIndia vishal.kadam Mumbai
1. FILE: multisite_manager_tool.module
/** * @file * Primary module hooks for Multisite Manager Tool module. */
Drupal does not have primary and secondary hooks. Instead of that, it is preferable to use the usual description: "Hook implementations for the [module name] module", where [module name] is the name of the module given in its .info.yml file.
2. FILE: src/SitesHelper.php
/** * Inject Services. * * @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $logger_factory * The logger factory. * @param \Drupal\Core\Database\Connection $database * The database connection. */ public function __construct(LoggerChannelFactoryInterface $logger_factory, Connection $database) {
FILE: src/Form/AddNewSiteForm.php
/** * Inject services. * * @param \Drupal\multisite_manager_tool\SitesHelper $sites_helper * The site helper. * @param \Drupal\Core\File\FileSystem $file_system * The file system. * @param \Drupal\Core\Database\Connection $database * The database connection. * @param \Drupal\Core\Site\Settings $settings * The settings. */ public function __construct(SitesHelper $sites_helper, FileSystem $file_system, Connection $database, Settings $settings) {
FILE: src/Form/CacheClearSiteForm.php
/** * The site helper. * * @param \Drupal\multisite_manager_tool\SitesHelper $sites_helper * The site helper. */ public function __construct(SitesHelper $sites_helper) {
FILE: src/Form/CacheClearSitesForm.php
/** * The site helper. * * @param \Drupal\multisite_manager_tool\SitesHelper $sites_helper * The site helper. */ public function __construct(SitesHelper $sites_helper) {
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.
- ๐ช๐ธSpain alexismmd
Hello @vishal.kadam,
I have already fix the problems.
Thank you very much for your review.
- ๐ฎ๐ณIndia vishal.kadam Mumbai
Rest looks fine to me.
Letโs wait for a Code Review Administrator to take a look and if everything goes fine, you will get the role.
- ๐ช๐ธSpain alexismmd
Please let me know if I need to do anything else.
I've noticed that some projects created in March have already been approved. - ๐ฎ๐น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/Controller/AddNewSiteController.php
Since that class uses only a method from the parent class, it does not need to use
ControllerBase
as parent class. Controllers do not need to have a parent class; as long as they implement\Drupal\Core\DependencyInjection\ContainerInjectionInterface
, they are fine.Furthermore, it is not necessary to use a controller to show a single form. A form class can be associated to a route.
- ๐ช๐ธSpain alexismmd
Hello @avpaderno,
I have already fix the issue.
Thank you very much for your review.
- ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น
The used placeholder contains a typo.
$this->messenger->addWarning( $this->t('Only one site is active, there is no multisite configuration. See the <a href=":ulr" target="_blank">Multisite Drupal</a> page for more information.', [':url' => 'https://www.drupal.org/docs/getting-started/multisite-drupal']) );
- ๐ฎ๐น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.
- ๐ช๐ธSpain alexismmd
Hi @avpaderno
Thank you very much for your review and your time!!