diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 789ab57..800cea4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,17 +4,13 @@ Thanks for your interest. This guide applies to every repository under [`resq-so ## Onboarding -Two curls get you from a bare machine to a working ResQ dev loop: +One curl gets you from a bare machine to a working ResQ dev loop: ```bash -# 1. Install the `resq` CLI (SHA-verified release binary, cargo fallback) -curl -fsSL https://raw.githubusercontent.com/resq-software/dev/main/scripts/install-resq.sh | sh - -# 2. Inside a cloned ResQ repo, install the canonical git hooks -cd && curl -fsSL https://raw.githubusercontent.com/resq-software/dev/main/scripts/install-hooks.sh | sh +curl -fsSL https://get.resq.software | sh ``` -The second script installs six hooks (pre-commit, commit-msg, prepare-commit-msg, pre-push, post-checkout, post-merge) that delegate to `resq pre-commit`. It also offers to scaffold a repo-type-aware `local-pre-push` (Rust / Python / Node / .NET / C++ / Nix). +This installs the SHA256-verified `resq` CLI (with a `cargo install --git` fallback), optionally clones a repo, and — when run inside a repo — installs the canonical git hooks: six hooks (pre-commit, commit-msg, prepare-commit-msg, pre-push, post-checkout, post-merge) that delegate to `resq pre-commit`, plus an offer to scaffold a repo-type-aware `local-pre-push` (Rust / Python / Node / .NET / C++ / Nix). Full contract: [`resq-software/dev/AGENTS.md#git-hooks`](https://github.com/resq-software/dev/blob/main/AGENTS.md#git-hooks). @@ -57,6 +53,23 @@ resq hooks doctor # report drift between installed and canonical hooks resq hooks update # rewrite installed hooks from embedded templates ``` +## Engineering standards + +Org-wide code standards live in [`docs/standards/`](./docs/standards/) — a +three-tier model plus a security overlay: + +- [**Tier 1 — Baseline**](./docs/standards/01-baseline.md): required toolchain, + hard rules, code shape (every repo). +- [**Tier 2 — Language enforcement**](./docs/standards/02-languages.md): per-language + tooling and idioms (TS, Python, C#, Rust, C/C++, Shell, SQL, …). +- [**Tier 3 — Safety overlay**](./docs/standards/03-safety-overlay.md): JSF / MISRA / + NASA Power of Ten for device- and flight-adjacent code. +- [**Security overlay**](./docs/standards/04-security.md): untrusted input, secrets, + auth, crypto. + +Per-repo specifics (commands, architecture, deliberate deviations) still live in +each repo's `AGENTS.md`. + ## Opening a PR 1. Branch from the default branch; name it per the pattern above. diff --git a/README.md b/README.md index dc6be36..c0ef89b 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ Organization-wide community health files, issue/PR templates, and the public pro | `profile/README.md` | The org profile shown at [github.com/resq-software](https://github.com/resq-software) | | `assets/` | Shared assets (banner, logo) used across org READMEs | | `README.template.md` | Standardized README template for new ResQ repositories | +| [`docs/standards/`](docs/standards/) | Org-wide engineering standards — the three-tier model (baseline, per-language, safety overlay) + security overlay | ### Community Health Files diff --git a/README.template.md b/README.template.md index 3e69273..bb72830 100644 --- a/README.template.md +++ b/README.template.md @@ -16,86 +16,52 @@ ═══════════════════════════════════════════════════════════════════ --> - -

- {{PROJECT_NAME}} Banner -

+ +
+ + +{{PROJECT_NAME}}

{{PROJECT_NAME}}

- -

- {{ONE_LINE_DESCRIPTION}} -

- - - ── Version ───────────────────────────────────────────────────────── - npm: https://img.shields.io/npm/v/{{NPM_PACKAGE}} - crates: https://img.shields.io/crates/v/{{CRATE_NAME}} - PyPI: https://img.shields.io/pypi/v/{{PYPI_PACKAGE}} - NuGet: https://img.shields.io/nuget/v/{{NUGET_PACKAGE}} - - ── Coverage ───────────────────────────────────────────────────────── - https://codecov.io/gh/resq-software/{{REPO}}/graph/badge.svg - - ── License (Apache-2.0, all ResQ projects) ───────────────────────── - https://img.shields.io/badge/license-Apache--2.0-blue.svg ---> -

- - - CI - - - - - npm version - - - - crates.io - - - - PyPI - - - - NuGet - - - - Coverage - - - - License: Apache-2.0 - - - - Total Stars - -

+[![CI](https://img.shields.io/github/actions/workflow/status/resq-software/{{REPO}}/ci.yml?branch=main&style=flat&logo=githubactions&logoColor=white&label=ci&color=0ea5e9)](https://github.com/resq-software/{{REPO}}/actions/workflows/ci.yml) +[![npm](https://img.shields.io/npm/v/{{NPM_PACKAGE}}?style=flat&logo=npm&label=npm&color=0ea5e9)](https://www.npmjs.com/package/{{NPM_PACKAGE}}) +[![crates.io](https://img.shields.io/crates/v/{{CRATE_NAME}}?style=flat&logo=rust&logoColor=white&color=0ea5e9)](https://crates.io/crates/{{CRATE_NAME}}) +[![PyPI](https://img.shields.io/pypi/v/{{PYPI_PACKAGE}}?style=flat&logo=pypi&logoColor=white&color=0ea5e9)](https://pypi.org/project/{{PYPI_PACKAGE}}/) +[![NuGet](https://img.shields.io/nuget/v/{{NUGET_PACKAGE}}?style=flat&logo=nuget&logoColor=white&color=0ea5e9)](https://www.nuget.org/packages/{{NUGET_PACKAGE}}) +[![Coverage](https://codecov.io/gh/resq-software/{{REPO}}/graph/badge.svg)](https://codecov.io/gh/resq-software/{{REPO}}) +[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-0ea5e9?style=flat)](./LICENSE) -

Documentation  ·  Website  ·  - Quick Start + Quick Start  ·  - Report Bug + Report Bug  ·  - Request Feature + Request Feature

+
+ +

◆   ◆   ◆

+ --- @@ -115,6 +81,7 @@ - [Changelog](#changelog) - [License](#license) - [Acknowledgements](#acknowledgements) +- [Stats](#stats) --- @@ -385,6 +352,26 @@ Licensed under the [Apache License, Version 2.0](./LICENSE). --- +## Stats + + + +
+ +![{{PROJECT_NAME}} activity](https://repobeats.axiom.co/api/embed/{{REPOBEATS_HASH}}.svg "Repobeats analytics image") + + + + Contributors + + +
+ +--- +