R.E.A.D How to select the right modules https://2015.midcamp.org/node/1106 Florida Drupal Camp 2015 #fldc15
Slide 1
Slide 2
Who You Are New to Drupal. Want to improve habits. Session curious.
Slide 3
Your Role A Drupal developer. A site architect. Functionality decision maker.
Slide 4
What it is all About How to quickly make smart, informed functionality decisions.
Slide 5
What we will Cover Steps to decide between a contrib, patched or custom module. Real world examples of R.E.AD Basics of a patch & Basics of a custom module.
Slide 6
Michael Miles From: Boston, MA Work: Genuine @WeAreGenuine(.com) Exp: Working with Drupal since 2008. Recently named an Acquia M.V.P Twitter: @mikemiles86 Drupal.org: mikemiles86 All the Places: mikemiles86
Slide 7
R.E.A.D Research what exists. Evaluate the options. Analyze the gap. Determine amount of change.
Slide 8
Research What Exists
Slide 9
Isolate Keywords Read documentation, specs, etc… Pay attention to unique nouns and verbs. Ask questions!
Slide 10
Perform Searches 30k+ Modules available. Favorite search engine “Drupal [keyword]”. Search on Drupal.org
Slide 11
Utilize the Community Use IRC: #drupal, #drupalsupport. Use Stack Exchange: drupal.stackexchange.com. Social Networks: G+, Facebook, LinkedIn. Even reddit! reddit.com/r/drupal.
Slide 12
Isolate Keywords. Perform Searches. Utilize Community.
Slide 13
Evaluate the Options
Slide 14
Read the Description What does the module do? What does the module not do? What does the module depend on?
Slide 15
Community Adoption Downloads vs. Installs vs. Age. Activity of issue queue. Issues are good, not bad!
Slide 16
Maintainer Activity Participate in issue queue? Accepting of feedback? Regular commits and/or releases?
Slide 17
Read the description. Check community adoption. Check maintainer activity.
Slide 18
Analyze the Gap
Slide 19
Download and Test the Module Gain a better understanding. Use a sandbox: simplytest.me. What is offered out of the box?
Slide 20
Discover Missing Functionality What does it not do? Missing 80%? Missing 20%? Bigger gap = Bigger effort.
Slide 21
Check for Community Solutions Look at the issue queue. Search “Drupal [module] [functionality]”. Ask questions!
Slide 22
Download and test the module. Discover missing functionality. Check for comunity solutions.
Slide 23
Determine Change
Slide 24
Review the Module Code Does it follow coding standards? Is it extendable? Can you figure out what does what?
Slide 25
Estimate Effort How much code to rewrite? How much code to add? How much time is there?
Slide 26
Extend or Alter Adding functionality? Changing functionality? Changing the modules goal?
Slide 27
Review module code. Estimate effort. Extend or alter?
Slide 28
Slide 29
Examples
Slide 30
Scenario #1
Slide 31
The Requirements WHEN SAVING A FILE ENTITY AND IT IS A JPEG IMAGE THEN THE EXIF META DATA NEEDS TO BE CAPTURED AND MAPPED TO CUSTOM FIELDS AND THESE MAPPINGS NEED TO BE EXPORTABLE USING FEATURES
Slide 32
Research What Exists
Slide 33
Isolate Keywords WHEN SAVING A FILE ENTITY AND IT IS A JPEG IMAGE THEN THE EXIF META DATA NEEDS TO BE CAPTURED AND MAPPED TO CUSTOM FIELDS AND THESE MAPPINGS NEED TO BE EXPORTABLE USING FEATURES
Slide 34
Perform Search We will focus on the keyword “Exif”
Slide 35
Search Google
Slide 36
Utilize the Community
Slide 37
Evaluate the Options Exif custom seems like best fit.
Slide 38
Read the Module Description
Slide 39
Look at Community Adoption
Slide 40
Look at Maintainer Activity
Slide 41
Analyze the Gap
Slide 42
Download and Test the Module
Slide 43
Discover Missing Functionality
Slide 44
Check for Solutions
Slide 45
Determine Change
Slide 46
Review Code
Slide 47
Estimate Effort Add Features integration. Alter primary key for mappings. Time is minimal.
Slide 48
Extend or Alter Adding features support. Not changing what module does. Extending.
Slide 49
Which Path to Choose Use module as is. Patch module. Write own module.
Slide 50
Patch! Module meets 90% of needs. Small gap, small effort. Extends module.
Slide 51
Slide 52
What is a Patch? drupal.org/patch. A structured list of changes to files. Reappliable to files. Focused on a single change.
Slide 53
Creating a Patch
Slide 54
Clone and branch module git repo.
Slide 55
Make changes to code.
Slide 56
Test your changes.
Slide 57
Generate patch file.
Slide 58
diff —git a/exif_custom.features.inc b/exif_custom.features.inc new file mode 100644 index 0000000..243bbe2 —- /dev/null +++ b/exif_custom.features.inc @@ -0,0 +1,158 @@ +<?php +/** + * @file + * Features file for the exif_custom module. + / + +/* + * Implements hook_features_api(). + */ +function exif_custom_features_api() { + return array( + ‘exif_custom’ => array( + ‘name’ => t(‘EXIF Custom mappings’), + ‘default_hook’ => ‘exif_custom_export_maps’, + ‘feature_source’ => TRUE, + ‘default_file’ => FEATURES_DEFAULTS_INCLUDED, + ‘file’ => drupal_get_path(‘module’, ‘exif_custom’) . ‘/exif_cus + ), + ); +} +…
Slide 59
Submitting a Patch
Slide 60
Create/comment on issue queue.
Slide 61
Attach your patch. Follow patch naming standards [module][description][issuenumber][commentnumber].patch
Slide 62
Watch for feedback.
Slide 63
Wait for merge. (hopefully)
Slide 64
Giving back to the community
Slide 65
Scenario #2
Slide 66
The Requirements WHEN SITE USES WORKBENCH TO MODERATE CONTENT THEN CAN CREATE MULTIPLE TRANSITIONS BETWEEN STATES AND TRANSITIONS ARE EXPORTABLE USING FEATURES WHEN EDITNG A CONTENT REVISION THEN CAN SCHEDULE A TRANSITION AND CAN SELECT DATE FOR FIRST STATE AND CAN SELECT DATE FOR SECOND STATE
Slide 67
Research What Exists
Slide 68
Isolate Keywords WHEN SITE USES WORKBENCH TO MODERATE CONTENT THEN CAN CREATE MULTIPLE TRANSITIONS BETWEEN STATES AND TRANSITIONS ARE EXPORTABLE USING FEATURES WHEN EDITNG A CONTENT REVISION THEN CAN SCHEDULE A TRANSITION AND CAN SELECT DATE FOR FIRST STATE AND CAN SELECT DATE FOR SECOND STATE
Slide 69
Search for Existing Modules We will focus on the keywords “workbench schedule”
Slide 70
Search Drupal
Slide 71
Evaluate the Options Look at Scheduler Workbench Integration.
Slide 72
Read the Module Description
Slide 73
Look at Community Adoption
Slide 74
Look at Maintainer Activity
Slide 75
Analyze the Gap
Slide 76
Download and Test the Module
Slide 77
Discover Missing Functionality Unable to create different transitions per type. Unable to select per revision. No features support.
Slide 78
Determine Change
Slide 79
Review Code
Slide 80
Estimate Effort Refactor creating schedules & transitions. Decouple transitions from content types. Add Features integration. Will take time.
Slide 81
Extend or Alter Changing how transitions/schedules are created. Changing purpose of module. Altering.
Slide 82
Which path to choose? Use module as is. Patch module. Write own module.
Slide 83
Build a custom module! Too big/complicated to be a patch. Would alter module goals. No other module exists to support use cases.
Slide 84
Slide 85
Writing a Module drupal.org/developing/modules. Follow Drupal coding standards. Make use of hooks and APIs. Test your code!
Slide 86
Contributing a Module Ask yourself: Could others use this? Seriously, is it abstracted enough?
Slide 87
Name module appropriately. Namespace based on dependencies. Be clear, not clever. Should indicate what module does.
Slide 88
Slide 89
Provide a detailed description. Explain what module does and does not do. Outline any dependencies. Help fellow R.E.A.Ders.
Slide 90
Slide 91
Be a good maintainer. Bugs are badges not bruises. Participate in the issue queue. Update, release and improve.
Slide 92
Slide 93
Let’s review
Slide 94
Remember to R.E.A.D Research what exists. Evaluate the options. Analyze the gap. Determine amount of change.
Slide 95
Slides & Notes bit.ly/fldcREAD bit.ly/fldcREADslides bit.ly/drupalREAD
Slide 96
Feedback @mikemiles86 #fldc15
Slide 97
Thank You! #fldc15 R.E.A.D / Michael Miles
