.github

Quirq's GitHub organization profile and shared community guidelines.

Type: Config. Settings the other repositories read.PythonUpdated Oct 7

Quirq on GitHub

The public organization profile and shared community guidelines for quirq-ai.

Looking for the product? Run XO Space locally, open the hosted app, or read the documentation.

What lives here

PathPurpose
profile/README.mdThe public organization overview.
profile/assets/Repository-owned profile artwork and its provenance.
CONTRIBUTING.mdHow to contribute across Quirq repositories.
SUPPORT.mdWhere to ask questions, report bugs and get account help.
SECURITY.mdPrivate security-reporting guidance.
CODE_OF_CONDUCT.mdCommunity expectations and reporting.
.github/ISSUE_TEMPLATE/Default bug and feature forms and help links.
.github/PULL_REQUEST_TEMPLATE.mdA short problem, change and validation template.
docs/maintaining.mdProfile decisions, inheritance rules and the maintenance checklist.

How defaults work

GitHub uses supported files in this public .github repository when a Quirq repository does not supply its own. Repository-specific guidance takes precedence. A repository with its own valid issue templates or issue-template configuration replaces the entire inherited template directory; GitHub does not merge them.

These files are not copied into product checkouts. Workflows and CODEOWNERS are not organization-wide defaults, and licenses remain the responsibility of each repository. See GitHub's community-file documentation.

Check a change

Use Python 3.12 or newer:

sh
python3 -m venv .venv
.venv/bin/python -m pip install -r requirements-dev.txt
.venv/bin/python scripts/validate.py

The check validates local Markdown links, profile assets and GitHub configuration. Public destination checks and visual review are separate: follow the maintenance checklist.

Open pull requests against main. Changes become the organization profile and eligible repository defaults when merged. XO Space has its own contribution workflow.

View README.md on GitHub ↗