Contributing

gcportrait is open source under the MIT License, and contributions are welcome: new asset types for the catalog, fixes, documentation, ideas. Everything runs locally in demo mode, so you need no Google Cloud account to work on it.

Get going

Node 22 (22.22.2 or newer) and pnpm through Corepack:

git clone https://github.com/florianchrometz/gcportrait.git && cd gcportrait
corepack enable
pnpm install
pnpm dev:demo     # the app in demo mode on http://localhost:5174
pnpm check        # format, lint, types, tests, catalog, provenance, licences

The guides

• Contributing guide

  From a fork to a green check and a pull request: setup, the local loop, the checks, changesets.

• agents.md

  The rules, the layout and every command, for people and AI assistants alike.

• Packages and data flow

  The workspace packages and how a Cloud Asset Inventory source becomes a drawn diagram.

• Asset catalog guide

  Add or change an asset type, a relation rule, a lens or a console link, with a fixture for each rule.

• Decision records

  Why things are the way they are: one record per decision.

• Backlog

  What is open: known defects, follow-ups and ideas for later, a good place to start.

Before you open a pull request

• Write the code yourself: nothing may be copied from other projects (the repository runs a provenance check).
• Add tests, and a fixture for every catalog rule; run pnpm check, and pnpm e2e for app changes.
• Check visual changes in the light and the dark theme.
• Add a changeset (pnpm changeset) for a change users will notice.

Contributions are accepted under the project’s licence, the MIT License (inbound = outbound), with no contributor licence agreement (see the contributing guide). Issues are the place for bugs and ideas.