Zowe Explorer Conformance Criteria Checklist

[crawr]

Zowe Conformance Criteria Checklist [Version 1]

Zowe Explorer draft conformance criteria: https://ent.box.com/s/hqzfsia30z09hsjo8gj40kunhjaw9ebj
Zowe Conformance Program: https://www.openmainframeproject.org/projects/zowe/conformance
Extensibility Epic for the technical details: #837
Other relevant issues: API Extender issues

Infrastructure

1. The product or application is built on top of at least one Zowe Explorer provided API. [Required, Please mark which one applies]

• a. Dependency (VS Code Extension Specific)
• b. Dependency (Data Provider)
• c. Dependency (Profiles)

a. Dependency (VS Code Extension Specific)

• 2. Extension defines Zowe Explorer as a VSCode extension dependency. (Code Example) [Required]
• 3. Extension uses IApiRegisterClient to register the new data provider during activation. (Code Example) [Required]
• 4. If the extension is adding new commands to the context menu, it adheres to the Zowe Explorer-provided contextual string format. (Code Example) [Required]
• 5. Extension follows the VS Code configuration property name format as indicated in the API documentation To be implemented [Best Practice]
• 6. Extension follows the Zowe Explorer error messaging format To be implemented [Best Practice]
• 7. Extension shows its registration in the Zowe Explorer log messages during activation To be implemented [Best Practice]

b. Dependency (Data Provider)

• 8. 9. If the extension contributes a new data provider to one of the Zowe Explorer tree browsers, it fully implements one of the Zowe Explorer API interfaces (MVS, JES, and USS). For the other unimplemented methods, it throws exceptions and provides meaningful user messages [Required]
• 10. If the extension implements a Zowe Explorer API interface, it provides a test suite that calls each of the implemented API methods [Required]
• 11. If the Extension has a Zowe CLI plugin counter-part, it must provide a new Zowe CLI profile type [Required]

c. Dependency (Profiles)

• 12. If the Extension has a Zowe CLI plugin counter-part, it must share profiles with the Zowe CLI plugin [Required]
• 13. Extension implements all Zowe Explorer Extender initialization methods such that it doesn't require Zowe CLI plugin to be installed [Best Practice]
• 14. Extension supports base profiles and tokens [Best Practice]
• 15. Extension supports JSON configuration file [Best Practice]
• 16. If the extension supports Zowe's Secure Credential store, it calls the Zowe Explorer-provided method To be implemented [Best Practice]

Naming and Packging

• 17. If the extension uses the word "Zowe" in its name, it abides with Linux Foundation's Trademark Usage rules https://www.linuxfoundation.org/trademark-usage/ [Required]
• 18. Extension has the "Zowe" keyword in the VS Code extension manifest and it is included with other extension Tags on the marketplace. (Code Example) [Best Practice]

Support

• 19. Submitter describes how Support is provided and Support details are clearly documented [Required]