zowe / zowe-cli

Zowe CLI
Eclipse Public License 2.0
108 stars 85 forks source link

OpenSSF Best Practices: Publish software architecture description #1760

Open adam-wolfe opened 11 months ago

adam-wolfe commented 11 months ago

Is your feature or enhancement request related to a problem or limitation? Please describe

In order to comply with the requirements of the OpenSSF Best Practices Silver Badge, we must provide a high-level description of the software architecture. I think that it would make sense to add this information to CONTRIBUTING.md or to a new .md file in the Zowe CLI repository.

Describe your enhancement idea

Identify key software components, the functionality they provide, and how they interact. Some kind of architectural diagram could be useful to illustrate how Zowe CLI works with Imperative to handle REST comms, command line activities, file i/o, etc.

github-actions[bot] commented 11 months ago

Thank you for raising this enhancement request. The community has 90 days to vote on it. If the enhancement receives at least 5 upvotes, it is added to our development backlog. If it receives fewer votes, the issue is closed.