This repository has been archived by the owner on Sep 17, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
Home
reynoldsalec edited this page Apr 25, 2014
·
3 revisions
Put this in hotsauce repo
Requirements
- Project human readable name: "HotPROJECT!" (don't forget the exclamation!)
- Project machine name should be "hot_PROJECT"
- Prefix Drupal machine names with “hot”, ex:
hot_PROJECT.module
- This only applies to the top-level Drupal elements. Individual css files and selectors don’t need the “hot” prefix.
- Style-related assets:
PROJECT-componentpart-specificattribute1...specificattributeN
- All JS globals:
hotPROJECTWhateverOtherThings
(camelspacing) - Within a closure (non-global JS): doesn't matter (won't have collisions)
- Documentation is a must!
- Require readme
- Require description in .info file and other relevant project metadata (package.json, bower.json, etc.)
- Describe the requirements/dependencies of your app
- Create a package.json file to record ALL project dependencies/external libraries/other stuff (should follow the standards defined by the OpenApp standard, with a couple added attributes as needed from regular package.json file)
- Keep your .info and your package.json module insync
- @todo: automatically pull .info dependencies and additional metadata (like drupal version) into our package.json (any other relevant stuff in .info?)
- @todo: how do we make the package.json format work with the OpenApp standard?
- Default App Category: "HotApps!"
- @todo: We should consider a more extensive app taxonomy in the future.