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
Building HotApps!
reynoldsalec edited this page Apr 26, 2014
·
8 revisions
- 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 an manifest.app file to record ALL project dependencies/external libraries/other stuff (should follow the standards defined by the OpenApp standard)
- You can use the App manifest project to generate a manifest.app file from your feature's .info file (if your app is based of a Drupal feature).
- Keep your .info and your manifest.app files in-sync
- Include links to the project home page and where to post issues in the manifest.app
- @todo: how could we convert manifest.app to an openapp.json format similar to package.json?
- Default App Category: "HotApps!"
- @todo: We should consider a more extensive app taxonomy in the future.
- Licensing: Ship with GPLv2
- If creating a brand new App, create an "App" node.
- Create an "App Release" node