项目的 README,来自 github.com/finos/architecture-as-code。合并为一个 markdown 文件:README.md。

Architecture as Code (AasC) aims to devise and manage software architecture via a human and machine readable and version-controlled codebase, fostering a robust understanding, efficient development, and seamless maintenance of complex software architectures.
This repository contains the Common Architecture Language Model (CALM) Specification, as well as capabilities being built to utilize the specification. This page lists the domains and capabilities being built by the official AasC community.
Whilst others are welcome to build their own capabilities, away from the AasC monorepo, we encourage you to join the community and contribute your projects to the AasC monorepo which has the benefits of being visible to the whole community; thereby attracting contributions and ensuring that changes to the manifest will be proactively built against your project.
Ready to get started? Check out the CALM tutorials.
Each project below is a subproject/codebase within this monorepo that is compiled and released independently (see security-insights.yml for a machine-readable list, per OSPS-QA-04.01).
| Project | Status | Maintainers | Builds |
|---|---|---|---|
| Common Architecture Language Model | Active | @rocketstack-matt, @jpgough-ms, @markscott-ms, @byrash | |
| CLI, Shared, Models & Widget Framework | Active | @aidanm3341, @lbulanti-ms, @willosborne, @Thels, @LeighFinegold, @markscott-ms, @byrash | |
| CALM AI | Active | @rocketstack-matt, @jimthompson5802 | No build, prompt tools only, managed separately to CLI for easier maintenance and broader reuse. |
| CALM Hub | Active | @jpgough-ms, @grahampacker-ms, @byrash | |
| CALM Hub UI | Active | @aidanm3341, @aamanrebello, @yoofitt96, @byrash | |
| CALM-Server | Active | @rocketstack-matt, @markscott-ms | |
| CALM Hub Extensions | Active | @rocketstack-matt, @markscott-ms | |
| Docs | Active | @rocketstack-matt, @jimthompson5802 | |
| CALM Learning Lab | Active | @rocketstack-matt | |
| CALM Canvas VSCode Plugin | Active | @rocketstack-matt, @markscott-ms, @byrash | |
| CALM Guard | Experimental | @gjs-opsflo, @eddie-knight |
Click the roadmap to view the interactive version with clickable cards.
Architecture as Code was developed as part of the DevOps Automation Special Interest Group before graduating as a top level project in it's own right. Our community Zoom meetups take place on the fourth Tuesday of every month, see here for upcoming and previous meetings. For active contributors we have Office Hours every Thursday, see the FINOS Event Calendar for meeting details.
Have an idea or feedback? Raise an issue in this repository.
Architecture as Code is one of three repositories that make up the FINOS Architecture as Code project, also known as CALM:
| Repository | Contents |
|---|---|
| architecture-as-code | This repository. The tools that use the CALM specification: CLI, server, shared libraries, data models, widgets, CALM Hub and its UI, the VS Code extension, CALM Guard, the documentation site and CALM Lab. |
| calm-schema | The CALM Meta Schema, its documentation and validation test suite. Published to npm as @finos/calm-schema, which the tools here depend on, and to calm.finos.org. |
| calm-governance | The governance home: project-wide governance, contribution guidelines, Maintainer roster and Code of Conduct. Holds no code. |
Propose a schema change in calm-schema, not here.
Architecture as Code operates as a monorepo of the projects that are being built to utilize the CALM specification.
We accept contributions via Pull Request, to make a contribution:
git checkout -b feature/fooBar)git commit -am 'Add some fooBar')git push origin feature/fooBar)Support is community-based and best-effort: ask in a Support Question issue or at Office Hours. SUPPORT.md states which releases are supported and when a release stops receiving security updates. To report a vulnerability privately, follow SECURITY.md, which also holds the dependency and code scanning policy and instructions for verifying release integrity. The project's threat model is in THREAT_MODEL.md.
The project's governance policies, Maintainer roster and Code of Conduct are maintained in finos/calm-governance and apply across every repository in the project.
| Document | Covers |
|---|---|
| GOVERNANCE.md | Roles, contribution rules, Maintainer voting, and how Maintainers are added and removed |
| MAINTAINERS.md | The project-wide Maintainer roster and the Lead Maintainer |
| MAINTAINERS_GUIDELINES.md | Repository-specific maintainer guidance for review, triage, quality, releases, and onboarding in this monorepo |
| CONTRIBUTING.md | Project-wide contribution guidelines |
| CODE_OF_CONDUCT.md | The Code of Conduct all participants are subject to |
The maintainers of each subproject in this monorepo are listed in the Projects table above.
A contributor must be nominated and approved by a vote of the existing Maintainers before they are granted write access to this repository, as set out in GOVERNANCE.md.
There aren't many standards to follow when it comes to Github actions - but some good rules of thumb for this project are;
Currently we have three typescript packages - two of which are managed via npm workspaces and one which is just raw npm. How these are built and manages slightly differs until they are all under the same worksapce - please look at their related github actions to learn how to build/test each of them.
Copyright FINOS
Distributed under the Apache License, Version 2.0.
SPDX-License-Identifier: Apache-2.0