EDIT: PLEASE NOTE THAT THIS PROJECT HAS MOVED TO https://drupal.org/project/wetkit

Hi,

I am working for the Government of Canada (Stats Can) with a variety of other government departments and public companies on a Drupal 7 Web Experience Toolkit Distribution located at: https://github.com/wet-boew/wet-boew-drupal

To see mobile responsiveness: http://responsinator.com/?url=sandbox.openplus.ca

ISSUE FORM:

  1. Component: Distribution (Drupal 7)
  2. Title: Web Experience Toolkit
  3. Description: The WxT-Drupal distribution is a web content management system which assists in building and maintaining innovative Web sites that are accessible, usable, and interoperable. This distribution is open source software and free for use by departments and external Web communities. This distribution relies and integrates extensively on the WET-BOEW jQuery Framework to leverage much of the rendering and overall markup. AdaptiveTheme is used as the base theme for its exceptional HTML5 support and exhaustive accessibility testing. Where possible WxT-Drupal will also leverage work from the Panopoly and Spark Distributions due to the amazing UX features being designed.
  4. Project Page (Drupal): http://drupal.org/sandbox/sylus/1910328
  5. Git Repository (GitHub): https://github.com/wet-boew/wet-boew-drupal
  6. Git Repository (Drupal): http://drupalcode.org/sandbox/sylus/1910328.git
  7. Documentation: https://github.com/wet-boew/wet-boew-drupal/wiki

Please use the GitHub repository link above to see the number of commits that have been made, as well as community involvement, issue tracking, etc. We did all of our work in GitHub so is best to use this to evaluate level of support and track record.

REVIEW BONUS:

Review #1: SWTOR: Drupal Code Sniffer + Manual Look (http://drupal.org/node/1914458#comment-7060126)
Review #2: Trello: Drupal Code Sniffer + Manual Look (http://drupal.org/node/1812464#comment-7060170)
Review #3: User Points: Drupal Code Sniffer + Manual Look (small) (http://drupal.org/node/1909588#comment-7060230)

CommentFileSizeAuthor
#22 pareview.txt528.95 KBsylus
#22 pareview_css_removed.txt107.11 KBsylus
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

sylus’s picture

Issue summary: View changes

Minor Changes

sylus’s picture

Issue summary: View changes

Documentation Link

sylus’s picture

Issue summary: View changes

Changes

patrickd’s picture

Status: Active » Needs review

welcome,
to indicate that you want to be reviewed, you got to have the status "needs review" set.
Read more about the project application wokflow here.

As there are currently hundreds of application in queue this process is going to take some time.
But you can get a review bonus and we will come back to your application sooner.

regards

mgifford’s picture

I've been using & reviewing the code for months now. I'd really like to see this get full module status. It's an important piece of getting Drupal adoption in government. Certainly for multi-lingual countries like Canada.

bhamrick’s picture

Status: Needs review » Needs work

Hi!

This is a cool project. There's some general repo cleanup you should do:

  • Create a version branch (e.g. 7.x-1.x).
  • Remove all files from the master branch except a README.txt directing users to the appropriate branch.

The code looks well formatted, though I see a couple trivial items that pareview will likely give errors on (Inline commenting rules, line breaks, etc.).

bhamrick’s picture

Issue summary: View changes

Make

joseph.olstad’s picture

Issue summary: View changes

fixing broken link

joseph.olstad’s picture

Issue summary: View changes

simplify fixed link

joseph.olstad’s picture

Issue summary: View changes

fix broken link

klausi’s picture

Status: Needs work » Closed (won't fix)

Closing due to lack of activity. Feel free to reopen if you are still working on this application.

mgifford’s picture

Status: Closed (won't fix) » Needs review

I'm going to put this up as needs review. This distribution is being actively worked on on GitHub and it has evolved a lot over the last year.

There's a bit of a development sprint running up to a launch deadline near the end of the month.

I do think it would be beneficial to release this under Drupal.org too. If only to have an official project page here.

I'll talk to @sylus about this after his launch date.

carwin’s picture

@mgifford: do you have any sort of update from @sylus on this yet? I agree that this would be a nice way to plug Drupal into government, so I'd like to see this go through as well.

I noticed over on his GitHub account that he released 3.0.1 on October 9th - is this the re-launch?

mgifford’s picture

This is definitely under active development still. The October 9th release is the culmination of months of work by @sylus & others.

@sylus is working closely with http://drupal.org/project/panopoly too and borrowing a lot from that distro.

carwin’s picture

Huzzah! Should I keep this application open then and wait for him to update his Drupal sandbox?

mgifford’s picture

The main development is being done here - https://github.com/wet-boew/wet-boew-drupal

I suspect that the Drupal.org project will always be a point to redirect to the github page and make stable releases.

I see Drupal.org offering a security release mechanism that nobody else can presently offer the Drupal community.

So ya, I'd either approve it now or just keep the application open.

nesta_’s picture

It appears you are working in the "master" branch in git. You should really be working in a version specific branch. The most direct documentation on this is Moving from a master branch to a version branch. For additional resources please see the documentation about release naming conventions and creating a branch in git.
Review of the master branch:

Remove the translations folder, translations are done on http://localize.drupal.org
Remove "version" from the info file, it will be added by drupal.org packaging automatically.
./webexp_default_install.inc: all functions should be prefixed with your module/theme name to avoid name clashes. See http://drupal.org/node/318#naming

http://ventral.org/pareview/httpgitdrupalorgsandboxsylus1341672git solved error.

nesta_’s picture

Status: Needs review » Needs work

change status when you fixed http://drupal.org/node/1494484#comment-6764914 :)

sylus’s picture

Status: Needs work » Needs review

Fixed branch issues and some architecture problems. For translations since these are custom modules it is not acceptable for them to house the .po files themselves?

New repo to use: http://drupal.org/sandbox/sylus/1910328

xmacinfo’s picture

@sylus: Would be easier for you if your application was from a single module (or a theme). And once you have git commit access, you could then create the whole distribution on d.o.

Testing a complete distribution takes time.

@mgifford: If you tried the WET distribution and you are confident it is fine as of now, please set the status to RTBC.

Is the 3.1 version tagged on GitHub?

mgifford’s picture

Status: Needs review » Reviewed & tested by the community

We've been using it for a while now. It keeps getting better, but we've used it for government clients.

I'm confident it's good to go on d.o!

mgifford’s picture

Issue summary: View changes

fix link, again (oops for last one)

mgifford’s picture

Also as recommendations, it is a project that's already made it to DrupalCon:
http://sydney2013.drupal.org/creating-dynamic-and-accessible-content-dru...

carwin’s picture

Status: Reviewed & tested by the community » Needs work

The product itself is fantastic, serious kudos there. The installation took a little longer than I'm used to, and there were a few warnings about missing French translations during the drush make. I also watched the DrupalCon Sydney presentation which was great - even cooler that your distro was used in it.

Before this distro can actually make it onto d.o it needs to pass some basic coding standards tests. I ran a PA Review on your sandbox here on d.o and it reported a multitude of problems. The output of the review was too large for d.o or Pastebin so I've hosted it on my Google Drive account for you to look at. I will try to help out personally with these problems as time permits because I'd really like to see this project available here.

Switching to the template I use for reviews:

README.txt
The README for this project is fine, although I find the formatting a little wonky.
project page
The project page for this project is fine.
Master Branch
It appears you are working in the "master" branch in git. You should really be working in a version specific branch. The most direct documentation on this is Moving from a master branch to a version branch. For additional resources please see the documentation about release naming conventions and creating a branch in git.

I'm guessing you've set up the d.o sandbox as a secondary git remote, you should be able to quickly remove it by using git push name-of-do-remote :master
Major coding standards / best practice issues
An automated review of your project has found some issues with your code; As coding standards make sure projects are coded in a consistent style, please have a look at the report and try to fix them as many as possible.
Anyway, note that issues found are possibly false positives and fixing all issues is not a requirement for getting through the application process. Also as I mentioned above, I'll help out here.

You can find the results of the automated report at LINK.

License
Please remove the LICENSE.txt file. Drupal will add the appropriate version automatically during packaging so your repository should not include it. This includes your -en and -fr versions.
PAReview: 3rd party code
Looks fine.
Multiple Applications
I haven't seen another one. No issues here.
Already Approved
Nope, too bad though. ;)
Idle Application
I thought it was for a while, but it looks like it's back to life, woo!
Code too short
No way, there's plenty of code here to show off the user's skill level. Just needs to meet standards.

Here again is the Code Review link in case it got lost in the main review.

sylus’s picture

Thanks for the awesome review I really appreciate this.

I have fixed the master branch issue on my repository and have started to fix the issues mentioned in your review. I did run a coder review without Code Sniffer so really appreciate all of the formatting issues it found and were missed.

I will post back here probably by tonight or tomorrow with most of these issues fixed.

My only question is in relation to the CSS issues that were found with the review.

Such as: Expected exactly one new line after opening brace of class.

I am going to be ignoring those errors as all of my CSS are treated as binary files since Compass compiles the SASS folder for me and also performs compression. Is this a safe assumption?

carwin’s picture

I think that's probably a pretty safe assumption, for now anyway. So far there aren't any rules regarding CSS compression via pre-processors and in fact the CSS coding styles are being revised and updated so I think it would be alright to ignore those. If it turns out to be a problem we can poke around the project's config.rb file an try to get SASS to output the compiled CSS in a better way.

If anyone else thinks differently please feel free to chime in.

sylus’s picture

Cool yeah if I ignore the JS (mostly from TinyMCE plugins) and CSS report goes down to 4200 so much more manageable :P I will likely also ignore issues related to feature exports such as modulename-pages_default.inc.

sylus’s picture

Issue summary: View changes

Project

sylus’s picture

Issue summary: View changes

Mod

sylus’s picture

Issue summary: View changes

Mod

sylus’s picture

Issue summary: View changes

Mod

sylus’s picture

Issue summary: View changes

Mod

klausi’s picture

Make sure to remove all your license files - all code on drupal.org is GPLv2 automatically. A copy the GPL will be added to downloadable tarballs automatically.

Same editor js files: appears to be 3rd party code. 3rd party code is not generally allowed on Drupal.org and should be deleted. This policy is described in the getting involved handbook. It also appears in the terms and conditions you agreed to when you signed up for Git access, which you may want to re-read, to be sure you're not violating other terms. The Libraries API module is a recommended method for adding 3rd party dependencies without directly including the code on Drupal.org.

And the line endings are broken in many files.

xmacinfo’s picture

Great review @carwin.

As for licensing files, drupal.org external libraries are validated against a whitelist of GPL-compatible libraries for distribution packages.

Please check these pages :
https://drupal.org/developing/distributions/drupalorg
https://drupal.org/node/1475972
https://www.gnu.org/licenses/license-list.html#GPLCompatibleLicenses
and
https://drupal.org/project/issues/drupalorg_whitelist

For non whitelisted libraries, you can use the Libraries module to download automatically the 3rd-party code (not hosted on d.o.) with hook_libraries_info and related functions.

sylus’s picture

Status: Needs review » Needs work
FileSize
107.11 KB
528.95 KB

I have performed an update and resolved most if not all issues reported by Code Sniffer except for the CSS notices which were a result of the SASS -> CSS compression. This was also mentioned by John Albin's talk in DrupalCon Sydney as being more efficient then Drupal's default aggregration (although this gets applied on top of it)

There are a few other issues such as inline indenting that I ignored if the file was created by Features module and would be overridden even if I fix the indentation down the line. (Assuming most just a false positive). Another is moving the translation folder but I will need full project access before I can begin using localize.drupal.org.

I have upload two attachments:

1) pareview.txt shows the results from running PHP Code Sniffer
2) pareview.txt shows the results from running PHP Code Sniffer with the CSS files removed
3) Ventral: http://ventral.org/pareview/httpgitdrupalorgsandboxsylus1910328git

Fixes made:

1) Licenses Removed
2) Removed the one 3rd party plugin in wetkit_wysiwyg (pdw) the other one present (wetkitcleanup) is built for this distro
3) Readme.md (Formatting is in markdown format as this repo is shared with GitHub)
4) Solved the issues that PHP Code Sniffer Reported
5) Am already leverage hook_libraries_info for the main jQuery Framework: wet-boew http://github.com/wet-boew/wet-boew
6) I have already started to whitelist some libraries most notably the wet-boew library

Quality of Product:

1) Passes PHP Code Sniffer (except for CSS and ignored areas mentioned above)
2) Is run under Continuous Integration and passes: https://travis-ci.org/wet-boew/wet-boew-drupal
3) Recent build is being further reviewed by a few governmental departments

GitHub Repo: http://github.com/wet-boew/wet-boew-drupal
Drupal Repo: http://drupalcode.org/sandbox/sylus/1910328.git

sylus’s picture

Issue summary: View changes

Mod

sylus’s picture

Issue summary: View changes

Review #1

sylus’s picture

Issue summary: View changes

Review #2

sylus’s picture

Status: Needs work » Needs review
mgifford’s picture

Status: Needs work » Reviewed & tested by the community

Ok, back to RTBC then. Looks like outstanding issues have been addressed.

mgifford’s picture

I just want to also quickly throw in here that this has already undergone a review by quite a few folks outside of Drupal.org. There have been nearly 750 issues posted (most of them also resolved) on Github. There is also a working group of 40 people who are working to guide this process (some from other known Drupal shops). The distribution is also running public municipality & federal government sites. Since this issue was opened nearly a year ago, hundreds of hours of development has gone into this distribution.

Much of the code is leveraging work of Panopoly and Spark Distributions which have also already been vetted. Will's been contributing back improvements to Panopoly as well to ensure that it provides better support for multi-lingual users.

So, although this is a big distro and it takes time to review, it shouldn't take this long to get approval. What's been suggested is that Will just throw up a simple module that is simple to review and then get permissions (like I have) to create new projects. That does seem like a somewhat flawed approval process.

sylus’s picture

Issue tags: +PAreview: review bonus

Adding review bonus tag.

xmacinfo’s picture

@mgifford: There is no need any more to go to a simpler route. This project is now RTBC and you did get an awesome review and you did all the corrections requested.

You did accomplish all the steps and @sylus did all the follow up to be compliant.

You are now at step 8:
https://drupal.org/node/1011698

Unfortunately, the application queue does occasionally experience a large backlog, and applications may sit in the queue for a few weeks at a time before getting reviewed.

You might want to read this page:
https://drupal.org/node/539608

And here is the workflow:
https://drupal.org/node/532400

mgifford’s picture

Thanks for the clarification @xmacinfo - I'm not a very patient person. Fortunately others in the community are.

mgifford’s picture

Issue summary: View changes

Review #3

klausi’s picture

Status: Reviewed & tested by the community » Fixed

Review of the 7.x-1.x branch:

This automated report was generated with PAReview.sh, your friendly project application review script. You can also use the online version to check your project. You have to get a review bonus to get a review from me.

manual review:

  1. README.md should be renamed to README.txt
  2. Translations should not be committed to the repository, so that translators can work on them independently on localize.drupal.org.
  3. You can ignore the coding standard errors in your generated CSS and PHP files, but there are still some legitimate errors, please check them.
  4. wetkit_bean_init(): empty function, so remove it. Same for wetkit_migrate_init() and possibly others?
  5. wetkitcleanup / editor_plugin.js is still there and looks like it can be found elsewhere on the internets? Note that no third party code is allowed on drupal.org, and exceptions are only made for modified libraries.
  6. "variable_get('wetkit_metatag_creator')": all variables that a module defines need to be removed in hook_uninstall(). Please check all your variables.
  7. wetkit_bean_configure_form(): why do you use system_settings_form() here, does not make sense?

But that are not application blockers, so ...

Thanks for your contribution, sylus!

I updated your account to let you promote this to a full project and also create new projects as either a sandbox or a "full" project.

Here are some recommended readings to help with excellent maintainership:

You can find lots more contributors chatting on IRC in #drupal-contribute. So, come hang out and get involved!

Thanks, also, for your patience with the review process. 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.

Thanks to the dedicated reviewer(s) as well.

sylus’s picture

Thanks @klausi I really appreciate all of your hard work in doing these reviews.

I actually learned quite a bit during this process and now PHP Code Sniffer will be a regular part of my workflow. The review bonus system was also quite great as I got to learn a bit about other peoples coding styles and discover new projects.

Thanks so much for the manual review as well; these issues will be fixed promptly!

@klausi++

xmacinfo’s picture

Congratulations, @sylus and thank you @klausi for the great review.

The approbation process may be long for some, but it is the best way to have a lot of developers contributing to the same code. Now that you can create full projects, there will be more contributors.

carwin’s picture

Congrats!!!

xmacinfo’s picture

@carwin: You deserve many thanks!

Automatically closed -- issue fixed for 2 weeks with no activity.

Anonymous’s picture

Issue summary: View changes

Mod

joseph.olstad’s picture

Issue summary: View changes

PLEASE NOTE THAT THIS PROJECT HAS MOVED TO https://drupal.org/project/wetkit