zowe-cli icon indicating copy to clipboard operation
zowe-cli copied to clipboard

Published 20 hours ago • verified publisher icon zowe

Review Contribution Guidelines for Currency and Requirements

Open BrandonJenkins14 opened this issue 5 years ago • 2 comments

Canonical: As a contributor to Zowe CLI, I want to understand what is a requirement vs. what is just a guideline to be Zowe conformant. I also want to be sure that the guidelines are current so that my plug-in is compatible and consistent with other components.

Tasks: Our conformance criteria asks contributors to adhere to requirements in the following documents. Review each to A. Ensure that they are technically correct and current and B. Adjust language throughout to clarify hard requirements vs soft guidelines:

  • [ ] Review https://github.com/zowe/zowe-cli/blob/conformance/CONTRIBUTING.md
    Assigned: Status: Not started

  • [ ] Review https://github.com/zowe/zowe-cli/blob/master/docs/PackagesAndPluginGuidelines.md
    Assigned: Status: Not started

  • [ ] Review https://github.com/zowe/zowe-cli/blob/master/docs/CommandFormatStandards.md
    Assigned: Status: Not started

  • [ ] Review https://github.com/zowe/zowe-cli/blob/master/docs/MaintainerVersioning.md
    Assigned: Status: Not started

  • [ ] Our conformance critera don't mention this file, but should still be checked for currency - https://github.com/zowe/zowe-cli/blob/conformance/docs/TESTING.md
    Assigned: Status: Not started

  • [ ] Our conformance critera don't mention this file, but should still be checked for currency - https://github.com/zowe/zowe-cli/blob/conformance/docs/ProfileGuidelines.md Assigned: Status: Not started

BrandonJenkins14 avatar Apr 29 '19 15:04 BrandonJenkins14

  • Consider which hard requirements can be automated as part of the conformance program testing process. (Remember, this review must be done for every new contribution, which could be many).

BrandonJenkins14 avatar Apr 29 '19 18:04 BrandonJenkins14

@JTonda I think this issue might have been completed as part of gathering our conformance criteria. We should verify with the squad.

BrandonJenkins14 avatar Sep 05 '19 17:09 BrandonJenkins14

This issue is outdated. Conformance guidelines have been revised at least twice since the creation of this issue. If new concerns exist in the current conformance guidelines, they should opened agains the conformance document which lives in a separate repository.

https://github.com/openmainframeproject/foundation/blob/main/zowe_conformance/test_evaluation_guide_table.md

gejohnston avatar Oct 11 '22 15:10 gejohnston