From b0641c2a42f95b0bb7f75671c4cac8f8c70de749 Mon Sep 17 00:00:00 2001 From: Uladzislau Date: Fri, 18 Nov 2022 18:53:22 +0100 Subject: [PATCH 1/6] GHI-105 CONFIRMANCE.md started Signed-off-by: Uladzislau --- CONFORMANCE.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 CONFORMANCE.md diff --git a/CONFORMANCE.md b/CONFORMANCE.md new file mode 100644 index 000000000..f1d209100 --- /dev/null +++ b/CONFORMANCE.md @@ -0,0 +1,42 @@ +# Zowe IntelliJ Plug-in Conformance Evaluation Criteria + +The Zowe Conformance Evaluation Criteria is a set of self-certifying and self-service tests to help the development community integrate and extend specific technology into the Zowe framework. + +This document describes the requirements of the three available conformance programs. Items marked **(required)** are required for an application to be conformant. Items marked **(best practice)** are considered best practices for conformant applications. + +Throughout this document you will find the following terminology being used: + +- _Zowe IntelliJ Plug-in_: An installable piece of software that provides new functionality to IntelliJ Platform or uses/calls services provided by related Zowe IntelliJ Plug-ins. Also simply referred to here as an "plug-ins", this can be a IntelliJ Plug-in or an independent piece of software. The conformance criteria below call out conformance requirements for Zowe IntelliJ Plug-ins, but it is possible that more kinds of plug-ins can be created. If such new plug-in kinds surface, then Zowe IntelliJ Plug-ins APIs, Zowe SDKs and this document can be expanded to support them in the future. +- _Zowe SDKs_ are [SDKs published by the Zowe project](https://docs.zowe.org/stable/user-guide/sdks-using) that provides various APIs for writing Zowe-based capabilities in general. + + +## Core + +| Item | Version | Required | Best Practise | Conformant | Criteria | Additional Information | +|:-----|:--------|:--------:|:-------------:|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------| +| 1 | v1 | x | | | Plug-in must have the unique name | | +| 2 | v1 | x | | | If the plug-in uses the word "Zowe" in its name, it abides by The Linux Foundation Trademark Usage Guidelines and Branding Guidelines to ensure the word Zowe is used in a way intended by the Zowe community | https://www.linuxfoundation.org/legal/trademark-usage | +| 3 | v1 | | x | | Normally the plug-in must not depend on other Zowe-related products until the real need | | +| 4 | v1 | x | | | Plug-in must be compatible with at least one of the latest major versions of IntelliJ | | +| 5 | v1 | | x | | Plug-in should be compatible with the latest stable version of IntelliJ | | +| 6 | v1 | | x | | Plug-in should support EAP IntelliJ versions when possible | | +| 7 | v1 | | x | | Plug-in should not use internal IntelliJ API when possible | | +| 8 | v1 | | x | | Plug-in should comply with the IntelliJ Platform UI Guidelines | https://jetbrains.github.io/ui/ | +| 9 | v1 | x | | | If the plug-in accesses the same mainframe service as a Zowe CLI plug-in, the connection information should be shared via Zowe Team Config (zowe.config.json) | | +| 10 | v1 | x | | | If the plug-in uses and stores sensitive information, it must ensure the safety of such kind of information, normally - with the help of native IntelliJ Platform functions (credentials storage, virtual files, etc.) | | + +## Distribution + +| Item | Version | Required | Best Practise | Conformant | Criteria | Additional Information | +|:-----|:--------|:--------:|:-------------:|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------| +| 1 | v1 | x | | | Plug-in is being delivered either through the JetBrains marketplace or through the standalone zip/tar package | | +| 2 | v1 | x | | | If the plug-in is being delivered through the standalone package, it must describe the reason, why it is not being delivered through the JetBrains marketplace | | + +## Documentation + +| Item | Version | Required | Best Practise | Conformant | Criteria | Additional Information | +|:-----|:--------|:--------:|:-------------:|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------| +| 1 | v1 | x | | | Plug-in must have comprehensive README.md with the information or the links to the other pieces of information on how to use, contribute, troubleshoot and support the plug-in | | +| 2 | v1 | x | | | If the plug-in relates to the other Zowe IntelliJ plug-in, it must describe the way how they are related (which components are used, if the target plug-in extends the source one; what part of the source plug-in is being enhanced/reworked) | | +| 3 | v1 | | x | | If the plug-in is intended to be extended, it should provide the information on how to extend it (external API of the plug-in, best-practices on how to extend the plug-in) | | +| 4 | v1 | | x | | If the plug-in uses Zowe SDK, it should mention the usage of the SDK at least in README.md with the information on what SDK is used, why and how it is used | | From 224644fbb04469569fb69ac25e7e8cf775c203b2 Mon Sep 17 00:00:00 2001 From: Uladzislau Date: Fri, 18 Nov 2022 18:56:44 +0100 Subject: [PATCH 2/6] GHI-105 Some updates to CONFORMANCE.md Signed-off-by: Uladzislau --- CONFORMANCE.md | 62 ++++++++++++++++++++++++++++---------------------- 1 file changed, 35 insertions(+), 27 deletions(-) diff --git a/CONFORMANCE.md b/CONFORMANCE.md index f1d209100..d118acd5a 100644 --- a/CONFORMANCE.md +++ b/CONFORMANCE.md @@ -1,42 +1,50 @@ # Zowe IntelliJ Plug-in Conformance Evaluation Criteria -The Zowe Conformance Evaluation Criteria is a set of self-certifying and self-service tests to help the development community integrate and extend specific technology into the Zowe framework. +The Zowe Conformance Evaluation Criteria is a set of self-certifying and self-service tests to help the development +community integrate and extend specific technology into the Zowe framework. -This document describes the requirements of the three available conformance programs. Items marked **(required)** are required for an application to be conformant. Items marked **(best practice)** are considered best practices for conformant applications. +This document describes the requirements of the three available conformance programs. Items marked **(required)** are +required for an application to be conformant. Items marked **(best practice)** are considered best practices for +conformant applications. Throughout this document you will find the following terminology being used: -- _Zowe IntelliJ Plug-in_: An installable piece of software that provides new functionality to IntelliJ Platform or uses/calls services provided by related Zowe IntelliJ Plug-ins. Also simply referred to here as an "plug-ins", this can be a IntelliJ Plug-in or an independent piece of software. The conformance criteria below call out conformance requirements for Zowe IntelliJ Plug-ins, but it is possible that more kinds of plug-ins can be created. If such new plug-in kinds surface, then Zowe IntelliJ Plug-ins APIs, Zowe SDKs and this document can be expanded to support them in the future. -- _Zowe SDKs_ are [SDKs published by the Zowe project](https://docs.zowe.org/stable/user-guide/sdks-using) that provides various APIs for writing Zowe-based capabilities in general. - +- _Zowe IntelliJ Plug-in_: An installable piece of software that provides new functionality to IntelliJ Platform or + uses/calls services provided by related Zowe IntelliJ Plug-ins. Also simply referred to here as an "plug-ins", this + can be a IntelliJ Plug-in or an independent piece of software. The conformance criteria below call out conformance + requirements for Zowe IntelliJ Plug-ins, but it is possible that more kinds of plug-ins can be created. If such new + plug-in kinds surface, then Zowe IntelliJ Plug-ins APIs, Zowe SDKs and this document can be expanded to support them + in the future. +- _Zowe SDKs_ are [SDKs published by the Zowe project](https://docs.zowe.org/stable/user-guide/sdks-using) that provides + various APIs for writing Zowe-based capabilities in general. ## Core -| Item | Version | Required | Best Practise | Conformant | Criteria | Additional Information | -|:-----|:--------|:--------:|:-------------:|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------| -| 1 | v1 | x | | | Plug-in must have the unique name | | -| 2 | v1 | x | | | If the plug-in uses the word "Zowe" in its name, it abides by The Linux Foundation Trademark Usage Guidelines and Branding Guidelines to ensure the word Zowe is used in a way intended by the Zowe community | https://www.linuxfoundation.org/legal/trademark-usage | -| 3 | v1 | | x | | Normally the plug-in must not depend on other Zowe-related products until the real need | | -| 4 | v1 | x | | | Plug-in must be compatible with at least one of the latest major versions of IntelliJ | | -| 5 | v1 | | x | | Plug-in should be compatible with the latest stable version of IntelliJ | | -| 6 | v1 | | x | | Plug-in should support EAP IntelliJ versions when possible | | -| 7 | v1 | | x | | Plug-in should not use internal IntelliJ API when possible | | -| 8 | v1 | | x | | Plug-in should comply with the IntelliJ Platform UI Guidelines | https://jetbrains.github.io/ui/ | -| 9 | v1 | x | | | If the plug-in accesses the same mainframe service as a Zowe CLI plug-in, the connection information should be shared via Zowe Team Config (zowe.config.json) | | -| 10 | v1 | x | | | If the plug-in uses and stores sensitive information, it must ensure the safety of such kind of information, normally - with the help of native IntelliJ Platform functions (credentials storage, virtual files, etc.) | | +| # | Ver | Required | Best Practise | Conformant | Criteria | Additional Information | +|:----|:---:|:--------:|:-------------:|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------| +| 1 | v1 | x | | | Plug-in must have the unique name | | +| 2 | v1 | x | | | If the plug-in uses the word "Zowe" in its name, it abides by The Linux Foundation Trademark Usage Guidelines and Branding Guidelines to ensure the word Zowe is used in a way intended by the Zowe community | https://www.linuxfoundation.org/legal/trademark-usage | +| 3 | v1 | | x | | Normally the plug-in must not depend on other Zowe-related products until the real need | | +| 4 | v1 | x | | | Plug-in must be compatible with at least one of the latest major versions of IntelliJ | | +| 5 | v1 | | x | | Plug-in should be compatible with the latest stable version of IntelliJ | | +| 6 | v1 | | x | | Plug-in should support EAP IntelliJ versions when possible | | +| 7 | v1 | | x | | Plug-in should not use internal IntelliJ API when possible | | +| 8 | v1 | | x | | Plug-in should comply with the IntelliJ Platform UI Guidelines | https://jetbrains.github.io/ui/ | +| 9 | v1 | x | | | If the plug-in accesses the same mainframe service as a Zowe CLI plug-in, the connection information should be shared via Zowe Team Config (zowe.config.json) | | +| 10 | v1 | x | | | If the plug-in uses and stores sensitive information, it must ensure the safety of such kind of information, normally - with the help of native IntelliJ Platform functions (credentials storage, virtual files, etc.) | | ## Distribution -| Item | Version | Required | Best Practise | Conformant | Criteria | Additional Information | -|:-----|:--------|:--------:|:-------------:|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------| -| 1 | v1 | x | | | Plug-in is being delivered either through the JetBrains marketplace or through the standalone zip/tar package | | -| 2 | v1 | x | | | If the plug-in is being delivered through the standalone package, it must describe the reason, why it is not being delivered through the JetBrains marketplace | | +| # | Ver | Required | Best Practise | Conformant | Criteria | Additional Information | +|:----|:---:|:--------:|:-------------:|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------| +| 1 | v1 | x | | | Plug-in is being delivered either through the JetBrains marketplace or through the standalone zip/tar package | | +| 2 | v1 | x | | | If the plug-in is being delivered through the standalone package, it must describe the reason, why it is not being delivered through the JetBrains marketplace | | ## Documentation -| Item | Version | Required | Best Practise | Conformant | Criteria | Additional Information | -|:-----|:--------|:--------:|:-------------:|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------| -| 1 | v1 | x | | | Plug-in must have comprehensive README.md with the information or the links to the other pieces of information on how to use, contribute, troubleshoot and support the plug-in | | -| 2 | v1 | x | | | If the plug-in relates to the other Zowe IntelliJ plug-in, it must describe the way how they are related (which components are used, if the target plug-in extends the source one; what part of the source plug-in is being enhanced/reworked) | | -| 3 | v1 | | x | | If the plug-in is intended to be extended, it should provide the information on how to extend it (external API of the plug-in, best-practices on how to extend the plug-in) | | -| 4 | v1 | | x | | If the plug-in uses Zowe SDK, it should mention the usage of the SDK at least in README.md with the information on what SDK is used, why and how it is used | | +| # | Ver | Required | Best Practise | Conformant | Criteria | Additional Information | +|:----|:---:|:--------:|:-------------:|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------| +| 1 | v1 | x | | | Plug-in must have comprehensive README.md with the information or the links to the other pieces of information on how to use, contribute, troubleshoot and support the plug-in | | +| 2 | v1 | x | | | If the plug-in relates to the other Zowe IntelliJ plug-in, it must describe the way how they are related (which components are used, if the target plug-in extends the source one; what part of the source plug-in is being enhanced/reworked) | | +| 3 | v1 | | x | | If the plug-in is intended to be extended, it should provide the information on how to extend it (external API of the plug-in, best-practices on how to extend the plug-in) | | +| 4 | v1 | | x | | If the plug-in uses Zowe SDK, it should mention the usage of the SDK at least in README.md with the information on what SDK is used, why and how it is used | | From 13927bda476dd5f0a50060f5b31c1388ce21181d Mon Sep 17 00:00:00 2001 From: Uladzislau Date: Fri, 18 Nov 2022 18:57:45 +0100 Subject: [PATCH 3/6] GHI-105 Some updates to CONFORMANCE.md Signed-off-by: Uladzislau --- CONFORMANCE.md | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/CONFORMANCE.md b/CONFORMANCE.md index d118acd5a..0a17298e1 100644 --- a/CONFORMANCE.md +++ b/CONFORMANCE.md @@ -3,8 +3,8 @@ The Zowe Conformance Evaluation Criteria is a set of self-certifying and self-service tests to help the development community integrate and extend specific technology into the Zowe framework. -This document describes the requirements of the three available conformance programs. Items marked **(required)** are -required for an application to be conformant. Items marked **(best practice)** are considered best practices for +This document describes the requirements of the three available conformance programs. Items marked **(Req)** are +required for an application to be conformant. Items marked **(BP)** are considered best practices for conformant applications. Throughout this document you will find the following terminology being used: @@ -20,31 +20,31 @@ Throughout this document you will find the following terminology being used: ## Core -| # | Ver | Required | Best Practise | Conformant | Criteria | Additional Information | -|:----|:---:|:--------:|:-------------:|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------| -| 1 | v1 | x | | | Plug-in must have the unique name | | -| 2 | v1 | x | | | If the plug-in uses the word "Zowe" in its name, it abides by The Linux Foundation Trademark Usage Guidelines and Branding Guidelines to ensure the word Zowe is used in a way intended by the Zowe community | https://www.linuxfoundation.org/legal/trademark-usage | -| 3 | v1 | | x | | Normally the plug-in must not depend on other Zowe-related products until the real need | | -| 4 | v1 | x | | | Plug-in must be compatible with at least one of the latest major versions of IntelliJ | | -| 5 | v1 | | x | | Plug-in should be compatible with the latest stable version of IntelliJ | | -| 6 | v1 | | x | | Plug-in should support EAP IntelliJ versions when possible | | -| 7 | v1 | | x | | Plug-in should not use internal IntelliJ API when possible | | -| 8 | v1 | | x | | Plug-in should comply with the IntelliJ Platform UI Guidelines | https://jetbrains.github.io/ui/ | -| 9 | v1 | x | | | If the plug-in accesses the same mainframe service as a Zowe CLI plug-in, the connection information should be shared via Zowe Team Config (zowe.config.json) | | -| 10 | v1 | x | | | If the plug-in uses and stores sensitive information, it must ensure the safety of such kind of information, normally - with the help of native IntelliJ Platform functions (credentials storage, virtual files, etc.) | | +| # | Ver | Req | BP | Conformant | Criteria | Additional Information | +|:----|:---:|:---:|:---:|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------| +| 1 | v1 | x | | | Plug-in must have the unique name | | +| 2 | v1 | x | | | If the plug-in uses the word "Zowe" in its name, it abides by The Linux Foundation Trademark Usage Guidelines and Branding Guidelines to ensure the word Zowe is used in a way intended by the Zowe community | https://www.linuxfoundation.org/legal/trademark-usage | +| 3 | v1 | | x | | Normally the plug-in must not depend on other Zowe-related products until the real need | | +| 4 | v1 | x | | | Plug-in must be compatible with at least one of the latest major versions of IntelliJ | | +| 5 | v1 | | x | | Plug-in should be compatible with the latest stable version of IntelliJ | | +| 6 | v1 | | x | | Plug-in should support EAP IntelliJ versions when possible | | +| 7 | v1 | | x | | Plug-in should not use internal IntelliJ API when possible | | +| 8 | v1 | | x | | Plug-in should comply with the IntelliJ Platform UI Guidelines | https://jetbrains.github.io/ui/ | +| 9 | v1 | x | | | If the plug-in accesses the same mainframe service as a Zowe CLI plug-in, the connection information should be shared via Zowe Team Config (zowe.config.json) | | +| 10 | v1 | x | | | If the plug-in uses and stores sensitive information, it must ensure the safety of such kind of information, normally - with the help of native IntelliJ Platform functions (credentials storage, virtual files, etc.) | | ## Distribution -| # | Ver | Required | Best Practise | Conformant | Criteria | Additional Information | -|:----|:---:|:--------:|:-------------:|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------| -| 1 | v1 | x | | | Plug-in is being delivered either through the JetBrains marketplace or through the standalone zip/tar package | | -| 2 | v1 | x | | | If the plug-in is being delivered through the standalone package, it must describe the reason, why it is not being delivered through the JetBrains marketplace | | +| # | Ver | Req | BP | Conformant | Criteria | Additional Information | +|:----|:---:|:---:|:---:|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------| +| 1 | v1 | x | | | Plug-in is being delivered either through the JetBrains marketplace or through the standalone zip/tar package | | +| 2 | v1 | x | | | If the plug-in is being delivered through the standalone package, it must describe the reason, why it is not being delivered through the JetBrains marketplace | | ## Documentation -| # | Ver | Required | Best Practise | Conformant | Criteria | Additional Information | -|:----|:---:|:--------:|:-------------:|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------| -| 1 | v1 | x | | | Plug-in must have comprehensive README.md with the information or the links to the other pieces of information on how to use, contribute, troubleshoot and support the plug-in | | -| 2 | v1 | x | | | If the plug-in relates to the other Zowe IntelliJ plug-in, it must describe the way how they are related (which components are used, if the target plug-in extends the source one; what part of the source plug-in is being enhanced/reworked) | | -| 3 | v1 | | x | | If the plug-in is intended to be extended, it should provide the information on how to extend it (external API of the plug-in, best-practices on how to extend the plug-in) | | -| 4 | v1 | | x | | If the plug-in uses Zowe SDK, it should mention the usage of the SDK at least in README.md with the information on what SDK is used, why and how it is used | | +| # | Ver | Req | BP | Conformant | Criteria | Additional Information | +|:----|:---:|:---:|:---:|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------| +| 1 | v1 | x | | | Plug-in must have comprehensive README.md with the information or the links to the other pieces of information on how to use, contribute, troubleshoot and support the plug-in | | +| 2 | v1 | x | | | If the plug-in relates to the other Zowe IntelliJ plug-in, it must describe the way how they are related (which components are used, if the target plug-in extends the source one; what part of the source plug-in is being enhanced/reworked) | | +| 3 | v1 | | x | | If the plug-in is intended to be extended, it should provide the information on how to extend it (external API of the plug-in, best-practices on how to extend the plug-in) | | +| 4 | v1 | | x | | If the plug-in uses Zowe SDK, it should mention the usage of the SDK at least in README.md with the information on what SDK is used, why and how it is used | | From bdc397f61e0bfac59f7005228f3a12037d35c5cf Mon Sep 17 00:00:00 2001 From: Uladzislau Date: Fri, 18 Nov 2022 19:14:55 +0100 Subject: [PATCH 4/6] GHI-105 Added item to the CONFORMANCE.md Signed-off-by: Uladzislau --- CONFORMANCE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONFORMANCE.md b/CONFORMANCE.md index 0a17298e1..3c1a0e309 100644 --- a/CONFORMANCE.md +++ b/CONFORMANCE.md @@ -32,6 +32,7 @@ Throughout this document you will find the following terminology being used: | 8 | v1 | | x | | Plug-in should comply with the IntelliJ Platform UI Guidelines | https://jetbrains.github.io/ui/ | | 9 | v1 | x | | | If the plug-in accesses the same mainframe service as a Zowe CLI plug-in, the connection information should be shared via Zowe Team Config (zowe.config.json) | | | 10 | v1 | x | | | If the plug-in uses and stores sensitive information, it must ensure the safety of such kind of information, normally - with the help of native IntelliJ Platform functions (credentials storage, virtual files, etc.) | | +| 11 | v1 | | x | | It is strongly recommended to use Gradle as a build tool. This is the direct recommendation of the IntelliJ Platform | | ## Distribution From 05a04f01d45f04a68358b4c7e00a512fef0a0a69 Mon Sep 17 00:00:00 2001 From: Uladzislau Date: Thu, 21 Dec 2023 19:04:39 +0100 Subject: [PATCH 5/6] Update CONFORMANCE.md Small change regarding standalone packages Signed-off-by: Uladzislau --- CONFORMANCE.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/CONFORMANCE.md b/CONFORMANCE.md index 3c1a0e309..8f7e075fb 100644 --- a/CONFORMANCE.md +++ b/CONFORMANCE.md @@ -36,10 +36,11 @@ Throughout this document you will find the following terminology being used: ## Distribution -| # | Ver | Req | BP | Conformant | Criteria | Additional Information | -|:----|:---:|:---:|:---:|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------| -| 1 | v1 | x | | | Plug-in is being delivered either through the JetBrains marketplace or through the standalone zip/tar package | | -| 2 | v1 | x | | | If the plug-in is being delivered through the standalone package, it must describe the reason, why it is not being delivered through the JetBrains marketplace | | +| # | Ver | Req | BP | Conformant | Criteria + | Additional Information | +|:----|:---:|:---:|:---:|:-----------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------| +| 1 | v1 | x | | | Plug-in is being delivered either through the JetBrains marketplace or through the standalone zip/tar package | | +| 2 | v1 | x | | | If the plug-in is being delivered through the standalone package, it must describe the strong reason, why it is not being delivered through the JetBrains marketplace, as well as implement all the necessary Zowe security policies for such kind of situations | | ## Documentation From 444971ca04f2dbe4dfaae0a96ccf23473871e6e0 Mon Sep 17 00:00:00 2001 From: Uladzislau Date: Thu, 21 Dec 2023 19:10:33 +0100 Subject: [PATCH 6/6] GHI-105 Formatting fix Signed-off-by: Uladzislau --- CONFORMANCE.md | 47 +++++++++++++++++++++++------------------------ 1 file changed, 23 insertions(+), 24 deletions(-) diff --git a/CONFORMANCE.md b/CONFORMANCE.md index 8f7e075fb..4f1ef2630 100644 --- a/CONFORMANCE.md +++ b/CONFORMANCE.md @@ -20,33 +20,32 @@ Throughout this document you will find the following terminology being used: ## Core -| # | Ver | Req | BP | Conformant | Criteria | Additional Information | -|:----|:---:|:---:|:---:|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------| -| 1 | v1 | x | | | Plug-in must have the unique name | | -| 2 | v1 | x | | | If the plug-in uses the word "Zowe" in its name, it abides by The Linux Foundation Trademark Usage Guidelines and Branding Guidelines to ensure the word Zowe is used in a way intended by the Zowe community | https://www.linuxfoundation.org/legal/trademark-usage | -| 3 | v1 | | x | | Normally the plug-in must not depend on other Zowe-related products until the real need | | -| 4 | v1 | x | | | Plug-in must be compatible with at least one of the latest major versions of IntelliJ | | -| 5 | v1 | | x | | Plug-in should be compatible with the latest stable version of IntelliJ | | -| 6 | v1 | | x | | Plug-in should support EAP IntelliJ versions when possible | | -| 7 | v1 | | x | | Plug-in should not use internal IntelliJ API when possible | | -| 8 | v1 | | x | | Plug-in should comply with the IntelliJ Platform UI Guidelines | https://jetbrains.github.io/ui/ | -| 9 | v1 | x | | | If the plug-in accesses the same mainframe service as a Zowe CLI plug-in, the connection information should be shared via Zowe Team Config (zowe.config.json) | | -| 10 | v1 | x | | | If the plug-in uses and stores sensitive information, it must ensure the safety of such kind of information, normally - with the help of native IntelliJ Platform functions (credentials storage, virtual files, etc.) | | -| 11 | v1 | | x | | It is strongly recommended to use Gradle as a build tool. This is the direct recommendation of the IntelliJ Platform | | +| # | Ver | Req | BP | Conformant | Criteria | Additional Information | +|:---|:---:|:---:|:--:|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------| +| 1 | v1 | x | | | Plug-in must have the unique name | | +| 2 | v1 | x | | | If the plug-in uses the word "Zowe" in its name, it abides by The Linux Foundation Trademark Usage Guidelines and Branding Guidelines to ensure the word Zowe is used in a way intended by the Zowe community | https://www.linuxfoundation.org/legal/trademark-usage | +| 3 | v1 | | x | | Normally the plug-in must not depend on other Zowe-related products until the real need | | +| 4 | v1 | x | | | Plug-in must be compatible with at least one of the latest major versions of IntelliJ | | +| 5 | v1 | | x | | Plug-in should be compatible with the latest stable version of IntelliJ | | +| 6 | v1 | | x | | Plug-in should support EAP IntelliJ versions when possible | | +| 7 | v1 | | x | | Plug-in should not use internal IntelliJ API when possible | | +| 8 | v1 | | x | | Plug-in should comply with the IntelliJ Platform UI Guidelines | https://jetbrains.github.io/ui/ | +| 9 | v1 | x | | | If the plug-in accesses the same mainframe service as a Zowe CLI plug-in, the connection information should be shared via Zowe Team Config (zowe.config.json) | | +| 10 | v1 | x | | | If the plug-in uses and stores sensitive information, it must ensure the safety of such kind of information, normally - with the help of native IntelliJ Platform functions (credentials storage, virtual files, etc.) | | +| 11 | v1 | | x | | It is strongly recommended to use Gradle as a build tool. This is the direct recommendation of the IntelliJ Platform | | ## Distribution -| # | Ver | Req | BP | Conformant | Criteria - | Additional Information | -|:----|:---:|:---:|:---:|:-----------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------| -| 1 | v1 | x | | | Plug-in is being delivered either through the JetBrains marketplace or through the standalone zip/tar package | | -| 2 | v1 | x | | | If the plug-in is being delivered through the standalone package, it must describe the strong reason, why it is not being delivered through the JetBrains marketplace, as well as implement all the necessary Zowe security policies for such kind of situations | | +| # | Ver | Req | BP | Conformant | Criteria | Additional Information | +|:--|:---:|:---:|:--:|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------| +| 1 | v1 | x | | | Plug-in is being delivered either through the JetBrains marketplace or through the standalone zip/tar package | | +| 2 | v1 | x | | | If the plug-in is being delivered through the standalone package, it must describe the strong reason, why it is not being delivered through the JetBrains marketplace, as well as implement all the necessary Zowe security policies for such kind of situations | | ## Documentation -| # | Ver | Req | BP | Conformant | Criteria | Additional Information | -|:----|:---:|:---:|:---:|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------| -| 1 | v1 | x | | | Plug-in must have comprehensive README.md with the information or the links to the other pieces of information on how to use, contribute, troubleshoot and support the plug-in | | -| 2 | v1 | x | | | If the plug-in relates to the other Zowe IntelliJ plug-in, it must describe the way how they are related (which components are used, if the target plug-in extends the source one; what part of the source plug-in is being enhanced/reworked) | | -| 3 | v1 | | x | | If the plug-in is intended to be extended, it should provide the information on how to extend it (external API of the plug-in, best-practices on how to extend the plug-in) | | -| 4 | v1 | | x | | If the plug-in uses Zowe SDK, it should mention the usage of the SDK at least in README.md with the information on what SDK is used, why and how it is used | | +| # | Ver | Req | BP | Conformant | Criteria | Additional Information | +|:--|:---:|:---:|:--:|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------| +| 1 | v1 | x | | | Plug-in must have comprehensive README.md with the information or the links to the other pieces of information on how to use, contribute, troubleshoot and support the plug-in | | +| 2 | v1 | x | | | If the plug-in relates to the other Zowe IntelliJ plug-in, it must describe the way how they are related (which components are used, if the target plug-in extends the source one; what part of the source plug-in is being enhanced/reworked) | | +| 3 | v1 | | x | | If the plug-in is intended to be extended, it should provide the information on how to extend it (external API of the plug-in, best-practices on how to extend the plug-in) | | +| 4 | v1 | | x | | If the plug-in uses Zowe SDK, it should mention the usage of the SDK at least in README.md with the information on what SDK is used, why and how it is used | |