- Issue created by @frank thoeny
- ๐ฎ๐น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, ๐ฎ๐น
I do not have time for a full review, but I can at least report the following points.
src/Controller/BookController.php
Since that class does not use methods 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.The correct method a controller class should implement to allow an instance to be created is
create()
, notcreateInstance()
. - ๐ฎ๐ณIndia vishal.kadam Mumbai
1.
11.1.x-dev
is a wrong name for a branch and should be removed. Release branch names always end with the literal .x as described in Release branches โ .2. FILE: README.md
The README file is missing the required sections โ - Requirements, Installation, and Configuration.
3. FILE: book_library_api.module
/** * @file * Provides a book entity type. */
The usual description for a .module file is โHook implementations for the [module name] moduleโ, where [module name] is the module name given in the .info.yml file.
function book_library_api_theme(): array {
function template_preprocess_book(array &$variables): void {
function template_preprocess_genre(array &$variables): void {
function book_library_api_form_alter(&$form, \Drupal\Core\Form\FormStateInterface $form_state, $form_id) {
Drupal coding standards say function declarations are written on a single line, even if they exceed 80 characters.
A similar issue exists in other files as well, and all of them can be resolved by fixing the phpcs job in GitLab CI.
4. FILE: src/Controller/BookController.php
// 'label' => $author,
// 'label' => $title,
FILE: src/Entity/Book.php
// ->setRequired(TRUE)
Remove commented code.
- ๐บ๐ธUnited States frank thoeny
vishal.kadam and avpaderno I want to thank you both for the time spent in reviewing my module. It is much appreciated.
I carefully corrected these issues, and when it came time to commit the changes, I created commit notes for each file. - ๐ฎ๐ณIndia vishal.kadam Mumbai
Remember to change status, when the project is ready to be reviewed. In this queue, projects are only reviewed when the status is Needs review.
- ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น
Normal is the correct priority, at this stage.
- ๐ฎ๐น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 also all the reviewers for helping with these applications.