This document outlines the R.E.A.D. method for determining whether to use an existing Drupal module, patch a module, or create a custom module. The steps are: Research what exists, Evaluate options, Analyze functionality gaps, and Determine the amount of required changes. Two examples are provided where an exif module is patched and a scheduler module is customized. The guidelines emphasize researching existing solutions, evaluating options like community support, analyzing missing functionality, and only developing custom modules for features other sites could use.

1. How to R.E.A.D
Steps for selecting the correct module.
#PatchOrCustom, #justREAD

2. Who You Are.
• Site Builder
• Developer
• Decision Maker
• New to Drupal
!
• Want to re-enforce habits

3. What’s it all about.
How to quickly make smart, informed decisions.

4. What we’ll cover.
• Steps to decide between a contrib, patched or
custom module.
• Basics of patching.
• Basics of writing a module.

5. Michael Miles
• Associate Director of PHP @ Genuine Interactive.
• Drank the Drupal Kool-aid in 2008. (it’s grape flavored)
!
• Twitter: @mikemiles86
• D.o: mikemiles86
@WeAreGenuine

6. A lover of memes.

7. How to R.E.A.D!
(yay acr!onyms!)

8. R.E.A.D
• Research what exists.
• Evaluate the options.
• Analyze the gap.
• Determine amount of change.
#justREAD

9. Research what exists.

10. Research what exists.
• Isolate keywords about functionality.
• Search for existing modules.
• Use the community.

12. Evaluate the options.

13. Evaluate the options.
• Read the module description.
• Look at community adoption.
• Look at maintainer activity.

15. Analyze the gap.

16. Analyze the gap.
• Download and test the module.
• Discover missing functionality.
• Check issue queue for solutions.

17. Patch not found.

18. Determine amount of change.

19. Determine amount of change.
• Review the module code.
• Estimate how much has to be changed.
• Do changes extend or alter module?

20. Let’s review.
Like developers…

21. Research.!
Find modules?
Evaluate.!
find best
fit?
Analyze.!
is there a
gap?
Use community solutions.
Determine.!
big change?
Build a custom module.
Use existing module.
Community
solutions
exist?
Patch.
YES YES YES
YES
NO NO
NO NO
YES
NO
…Flow Chart FTW!

22. Research.!
Find modules?
Evaluate.!
find best
fit?
Analyze.!
is there a
gap?
Use community solutions.
Determine.!
big change?
Build a custom module.
Use existing module.
Community
solutions
exist?
Patch.
YES YES YES
YES
NO NO
NO NO
YES
NO
…Flow Chart FTW!

23. Examples.

24. Scenario #1.

25. The Requirements.
WHEN SAVING A FILE
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
!

26. Step 1
Research what exists.

27. WHEN SAVING A FILE
Research what exists.
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.
!
Isolate keywords about functionality.

28. Research what exists.
Search for existing modules.

29. Research what exists.
Talk to the community.
IRC: #drupal, #drupal-support

30. Research what exists.
Find possible existing solutions
• The Exif module
• The Exif custom module

31. Step 2
Evaluate the options.

32. Evaluate the options
Read the module description.

33. Evaluate the options
Look at community adoption.
Exif
Exif Custom

34. Evaluate the options
Look at maintainer activity.

35. Evaluate the options
Determine best fit.

36. Step 3
Analyze the gap.

37. Analyze the gap.
Download and test the module.

38. Analyze the gap.
Discover missing functionality.

39. Analyze the gap.
Check issue queue for solutions.

40. Step 4
Determine amount of change.

41. Determine amount of change.
Review the module code.

42. Determine amount of change.
Estimate how much has to be changed.
• Requires little rewriting of code base.
• Need to add new hooks and one new file.

43. Determine amount of change.
Will changes extend or alter the module?

44. Which path to choose?
• Patch Exif Custom module
!
• Write own Exif module

45. PATCH!

46. What is a Patch?
• drupal.org/patch
• A structured list of changes to a file.
• Used to re-create changes to a files.
• Focus on a single change.

47. How to create a Patch.
• Clone module repository.
• Create a new branch.
• Make changes to code.
• Test changes.
• Generate the patch.

48. Clone module repository.
mm:~$ git clone --branch 7.x-1.x http://git.drupal.org/project/exif_custom.git

49. Create a branch.
mm:exif_custom$ git checkout -b patch/features_integration

50. Make changes.

51. Test changes.

52. Create the patch file.
mm:exif_custom$ git diff 7.x-1.x > exif_custom-features_integration.patch

53. How to submit a Patch.
• Create/Comment on an issue.
• Attach the patch.
• [description]-[issue-number]-[comment-number].patch
• Revise based on testing/reviews.

54. Create an issue.

55. Attach the patch.
[description]-[issue-number]-[comment-number].patch

57. Contributing back to the community.

58. Scenario #2.

59. 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

60. Step 1
Research what exists.

61. Research what exists.
Isolate keywords about functionality.
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

62. Research what exists.
Search for existing modules.

63. Step 2
Evaluate the options.

64. Evaluate the options
Read the module description.

65. Evaluate the options
Look at community adoption.

66. Evaluate the options
Look at maintainer activity.

67. Step 3
Analyze the gap.

68. Analyze the gap.
Download and test the module.

69. Analyze the gap.
Discover missing functionality.
• Unable to create different transitions per type
• Unable to select different transitions for revisions
• No features integration.

70. Step 4
Determine amount of change.

71. Determine amount of change.
Review the module code.

72. Determine amount of change.
Estimate how much has to be changed.
• Will need to change how transitions are created.
• Will need to change how schedules are stored.
• Will need to add features integration.

73. Determine amount of change.
Will changes extend or alter the module?

74. Which path to choose?
• Patch Scheduler workbench module
!
• Write own scheduler module

75. CUSTOM MODULE!

76. Module Writing Guidelines.
• drupal.org/developing/modules
• Follow Drupal coding standards.
• Make use of hooks and APIs.
• Test your code.

77. Contributing a module.
• Is it functionality other could use?
• Name appropriately.
• Provide accurate description.
• Be an active maintainer.

78. Name appropriately.

79. Provide detailed description.

80. Be an active maintainer.

81. Free QA and improvements from community.

83. How to R.E.A.D.
• Research what exists.
• Evaluate the options.
• Analyze the gap.
• Determine amount of change.
#justREAD

84. Thank You!
@mikemiles86