-
Notifications
You must be signed in to change notification settings - Fork 7
feat(docs): CPLYTM-1273 improve SUBPROJECTS.md #9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,10 +16,14 @@ Please report unacceptable behavior to one of the Code of Conduct [Committee mem | |
|
|
||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The "get in-touch" link directs to a 404 Error. It may be best to point to the #community channel in the ComplyTime Slack Workspace.
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @hbraswelrh Not sure about this section, just updated with our repos to this. But the link works fine. Thank for bring the community channel part. Could you suggest the slack link and we could take care of it another PR along with the complytime readme. WDYT? |
||
| In addition to this repository, ComplyTime has several sub-projects: | ||
|
|
||
| * **complyctl**: A command-line tool for interacting with ComplyTime services. | ||
| * **complybeacon**: A service for continuous compliance monitoring. | ||
| * **complyscribe**: A service for generating compliance documentation. | ||
| * **cac-transpiler**: A tool for transpiling compliance-as-code artifacts. | ||
| * **[complyctl](https://github.com/complytime/complyctl)**: A command-line tool for streamlining end-to-end compliance workflows on local systems. | ||
| * **[complyscribe](https://github.com/complytime/complyscribe)**: A workflow automation tool for compliance content authoring. | ||
| * **[complytime-collector-components](https://github.com/complytime/complytime-collector-components)** (ComplyBeacon): A policy-driven observability toolkit for compliance evidence collection, extending the OpenTelemetry standard. | ||
| * **[complytime-policies](https://github.com/complytime/complytime-policies)**: Engineering policies expressed in [Gemara](https://github.com/ossf/gemara) for the ComplyTime project. | ||
| * **[gemara-mcp-server](https://github.com/complytime/gemara-mcp-server)**: An MCP server for automating the authoring of GRC Risk Assessment documentation in Gemara. | ||
| * **[website](https://github.com/complytime/website)**: The ComplyTime project website. | ||
|
|
||
| For a complete list of all subprojects and their current status, see [SUBPROJECTS.md](./SUBPROJECTS.md). | ||
|
|
||
| The following sections provide a general overview for contributing to any of the ComplyTime repositories. | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,154 @@ | ||
| # SubProjects: ComplyTime | ||
| # ComplyTime Subprojects | ||
|
|
||
| ## `complyctl` | ||
| This document outlines the subprojects under the ComplyTime umbrella, their status, and contribution guidelines. Each subproject has its own maintainers, roadmap, and contribution guidelines while adhering to the overall ComplyTime [governance](./GOVERNANCE.md) and [code of conduct](./CODE_OF_CONDUCT.md). | ||
|
|
||
| A command-line tool for streamlining end-to-end compliance workflows on local systems. | ||
| ## Subproject Maturity Levels | ||
|
|
||
| ### In Scope Repositories | ||
| | Status | Description | | ||
| |--------|-------------| | ||
| | **π’ Active** | Production-ready, actively maintained with regular releases | | ||
| | **π‘ Incubating** | Under active development, working toward stability | | ||
| | **π΅ Supporting** | Foundational/utility project, stable but lower release cadence | | ||
| | **βͺ Archived Or Empty** | Empty or no longer actively maintained, kept for historical reference | | ||
|
|
||
| | Name | Function | | ||
| |--------------------------------|--------------------| | ||
| | `complyctl` | The main CLI repo | | ||
| | `compliance-to-policy-plugins` | Plugins repository | | ||
| ## Current Subprojects | ||
|
|
||
| ### complyctl | ||
sonupreetam marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## `complyscribe` | ||
| **Description**: A command-line tool for streamlining end-to-end compliance workflows on local systems. | ||
|
|
||
| A workflow automation tool for compliance content authoring | ||
| **Status**: π‘ Incubating | ||
| **Repository**: [complytime/complyctl](https://github.com/complytime/complyctl) | ||
| **Language**: Go | **License**: Apache-2.0 | ||
|
|
||
| ## In Scope Repositories | ||
| --- | ||
|
|
||
| | Name | Function | | ||
| |----------------|---------------| | ||
| | `complyscribe` | The main repo | | ||
| ### complyscribe | ||
|
|
||
| ## `complybeacon` | ||
| **Description**: A workflow automation tool for compliance content authoring. | ||
|
|
||
| A policy-driven observability toolkit for compliance evidence collection | ||
| **Status**: π‘ Incubating | ||
| **Repository**: [complytime/complyscribe](https://github.com/complytime/complyscribe) | ||
| **Language**: Python | **License**: Apache-2.0 | ||
|
|
||
| ## In Scope Repositories | ||
| --- | ||
|
|
||
| | Name | Function | | ||
| |----------------|---------------| | ||
| | `complybeacon` | The main repo | | ||
| ### complytime-collector-components (ComplyBeacon) | ||
|
|
||
| **Description**: A policy-driven observability toolkit for compliance evidence collection, extending the OpenTelemetry standard. | ||
|
|
||
| **Status**: π‘ Incubating | ||
| **Repository**: [complytime/complytime-collector-components](https://github.com/complytime/complytime-collector-components) | ||
| **Language**: Go | **License**: Apache-2.0 | ||
|
|
||
| --- | ||
|
|
||
| ### complytime-collector-distro | ||
|
|
||
| **Description**: Pre-built OpenTelemetry Collector distribution for ComplyBeacon releases. | ||
|
|
||
| **Status**: βͺ Empty | ||
| **Repository**: [complytime/complytime-collector-distro](https://github.com/complytime/complytime-collector-distro) | ||
| **License**: Apache-2.0 | ||
|
|
||
| --- | ||
|
|
||
| ### org-infra | ||
|
|
||
| **Description**: Reusable workflows, shared configurations, and templates for the ComplyTime organization. | ||
|
|
||
| **Status**: π’ Active | ||
| **Repository**: [complytime/org-infra](https://github.com/complytime/org-infra) | ||
| **Language**: Python | **License**: Apache-2.0 | ||
|
|
||
| --- | ||
|
|
||
| ### website | ||
|
|
||
| **Description**: The ComplyTime project website. | ||
|
|
||
| **Status**: π‘ Incubating | ||
| **Repository**: [complytime/website](https://github.com/complytime/website) | ||
|
|
||
| --- | ||
|
|
||
| ### .github | ||
|
|
||
| **Description**: Organization management via [Peribolos](https://docs.prow.k8s.io/docs/components/cli-tools/peribolos/). | ||
|
|
||
| **Status**: π΅ Supporting | ||
| **Repository**: [complytime/.github](https://github.com/complytime/.github) | ||
|
|
||
| --- | ||
|
|
||
| ### community | ||
|
|
||
| **Description**: Community documentation including contributing guidelines, governance, and code of conduct. | ||
|
|
||
| **Status**: π΅ Supporting | ||
| **Repository**: [complytime/community](https://github.com/complytime/community) | ||
| **License**: Apache-2.0 | ||
|
|
||
| --- | ||
|
|
||
| ### gemara-content-service | ||
|
|
||
| **Description**: A content API service for [Gemara](https://github.com/ossf/gemara) β the GRC Engineering Model for Automated Risk Assessment. Naming not yet finalized. | ||
|
|
||
| **Status**: π‘ Incubating | ||
| **Repository**: [complytime/gemara-content-service](https://github.com/complytime/gemara-content-service) | ||
| **License**: Apache-2.0 | ||
|
|
||
| --- | ||
|
|
||
| ### complytime-policies | ||
|
|
||
| **Description**: Engineering policies expressed in [Gemara](https://github.com/ossf/gemara) for the ComplyTime project. | ||
|
|
||
| **Status**: π‘ Incubating | ||
| **Repository**: [complytime/complytime-policies](https://github.com/complytime/complytime-policies) | ||
| **License**: Apache-2.0 | ||
|
|
||
| ### gemara-mcp-server | ||
sonupreetam marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| **Description**: An MCP server for automating the authoring of GRC Risk Assessment documentation in [Gemara](https://github.com/ossf/gemara). | ||
|
|
||
| **Status**: π‘ Incubating | ||
| **Repository**: [complytime/gemara-mcp-server](https://github.com/complytime/gemara-mcp-server) | ||
| **Language**: Go | **License**: Apache-2.0 | ||
|
|
||
| --- | ||
|
|
||
| ## Process for Adding New Subprojects | ||
|
|
||
| 1. **Open a Proposal Issue** in the [community repository](https://github.com/complytime/community/issues) with: | ||
| - Project name and description | ||
| - Problem statement and goals | ||
| - Proposed maintainers (minimum 2) | ||
| - Technical architecture overview | ||
| - Alignment with ComplyTime's mission | ||
|
|
||
| 2. **Community Review**: The proposal will be open for community discussion for at least 2 weeks. | ||
|
|
||
| 3. **TOC Approval**: The [Technical Oversight Committee](./GOVERNANCE.md) will vote on the proposal. | ||
|
|
||
| ## Subproject Requirements | ||
|
|
||
| All subprojects must: | ||
|
|
||
| - Follow the ComplyTime [Code of Conduct](./CODE_OF_CONDUCT.md) | ||
| - Adhere to the [Contributing Guidelines](./CONTRIBUTING.md) | ||
| - Have at least two maintainers | ||
| - Maintain clear documentation | ||
| - Follow ComplyTime's licensing guidelines (Apache-2.0 preferred) | ||
|
|
||
| ## Process for Archiving Subprojects | ||
|
|
||
| Subprojects may be archived when: | ||
|
|
||
| - No active maintainers remain after reasonable recruitment efforts | ||
| - The project no longer aligns with ComplyTime's direction | ||
| - The project has been superseded by another solution | ||
| - A supermajority vote of the TOC approves archival | ||
|
|
||
| Archived projects remain available for reference but no longer receive updates or support. | ||
Uh oh!
There was an error while loading. Please reload this page.