As per coding standard documentation at https://www.drupal.org/coding-standards/docs#file, the @file docblock should not be there in the files that contain a namespaced class/interface/trait, whose file name is the class name with a .php extension.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Pavan B S created an issue. See original summary.

Pavan B S’s picture

Assigned: Pavan B S » Unassigned
Status: Active » Needs review
FileSize
5.41 KB

Applying the patch, please review.

minnur’s picture

@Pavan B S OMG really ?

dhruveshdtripathi’s picture

Status: Needs review » Reviewed & tested by the community
FileSize
137.66 KB
48.93 KB

Hi @minnur

Yes! @file docblocks should not be there in the files that contain a namespaced class/interface/trait, whose file name is the class name with a .php extension. I reviewed & tested the patch and found that @file docblocks are decreased from 16 to 3. Those 3 @file docblocks are from .module, .js. and .twig files. Screenshots are attached which shows the same.

minnur’s picture

Guys, I understand you would like to build Drupal profile, creating one line changes and then the project appears on your d.o profile with (1 commit). It is great that you're using Drupal and contributing, let me tell you my story.

I started working as an intern at a Drupal shop in SoCal and had to spend day and nights figuring out things in Drupal and trying to find real world problems that I could solve or help improve existing modules/themes in a way that it would be visible and valuable to others. Never crossed my mind that my Drupal org profile would impress anyone with a whole bunch of simple commits. Believe me this won't help you to get any good Drupal jobs.

Few years later I started looking more into possibility of creating a good and useful module. I tried my best to create something good, stable and usable and I came up with the ads module. This was back when Drupal 7 just release and no D6 ads module existed. Luckily for me one of my clients needed ads module so I decided to build one and in about 2-3 months a released it on d.o and now over 6000 sites using it. I admit the module is not very stable, has some bugs but could be fixed. Then I created few more and helped others with their modules.

Even the module didn't bring much money it showed me that I can create something useful and valuable and proved me that even one module could help you get good contact job to build something amazing for your clients.

Let my summarize here. What I wanted to say is that rather than making one line commits try find something that interests you and work on it, show it to the world. It could be Drupal module, Drupal theme or some other tools that would improve things.

Here some ideas: Implement nice Media module that you could just install it and use it. It doesn't have to be very complex and work with every possible site. Create a simple commerce system that would provide basic functionality and nothing complex like Drupal Commerce. Create nice admin theme using React/AngularJS.

Here is a list of pending projects (under review): https://www.drupal.org/project/issues/projectapplications

Thanks,

Minnur

Pavan B S’s picture

@minnur, thanks for the valuable suggestions, I will try to create own modules.

dhruveshdtripathi’s picture

Hello @minnur

Thank you! I'm having my module on drupal.org and I'm also working on porting modules from D7 to D8. Creating such issues is not just about making our profile good. There are few new coding standard changes are coming because Drupal project maintainers are making some good changes for Drupal 9. You must be knowing these things. Anyways, instead of only creating our modules / themes, we also try to contribute in other projects as well so that we can make Drupal better. Thank you for suggesting pending projects. Looking forward to work with them.