Github user filmaj commented on a diff in the pull request:
https://github.com/apache/cordova-test-platform/pull/1#discussion_r128834387
--- Diff: PlatformRequirements.md ---
@@ -0,0 +1,144 @@
+
+# New Platform Checklist
+
+## Stand-alone scripts
+
+bin/create scripts
+- bin/create _(typically a node script)_
+- bin/create.bat for windows
+ - windows .bat file typically just calls bin/create with node
+
+bin/update
+- not entirely sure this code is run, or needs to exist with newish
non-destructive platform updates
+
+## Package Expectations
+
+- Platforms must have a package.json in their root.
+- Package.json exports a 'main', usually `"main": "src/cordova/Api.js"`
+ - This allows other modules to simply require() the path to this
platform and get access to the Api.
+
+## Api (Platform) Expectations
+- The PlatformApi class
+ - The PlatformApi class is an abstraction around a particular platform
that exposes all the actions, properties, and methods for this platform so they
are accessible programmatically.
+ - It can install & uninstall plugins with all source files, web assets
and js files.
+ - It exposes a single 'prepare' method to provide a way for
cordova-lib to apply a project's setting/www content to the platform.
--- End diff --
I would expand on this, in particular the "project settings" part.
Something like "interpolates metadata from a cordova project's config.xml (link
to cordova docs' config.xml section) (such as application name, description,
etc.) into the format expected by the platform."
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@cordova.apache.org
For additional commands, e-mail: dev-h...@cordova.apache.org
