From c884905344fcf89206e23431c84d996481514ce5 Mon Sep 17 00:00:00 2001 From: Somasundaram Ayyappan <1802828+somus@users.noreply.github.com> Date: Fri, 12 Jun 2026 15:39:50 +0530 Subject: [PATCH 01/11] chore: add repository foundation --- .github/ISSUE_TEMPLATE/bug.yml | 44 +++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 6 +++++ .github/ISSUE_TEMPLATE/rfc.yml | 44 +++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/task.yml | 44 +++++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 20 ++++++++++++++ .github/workflows/guardrails.yml | 21 +++++++++++++++ CONTRIBUTING.md | 42 +++++++++++++++++++++++++++++ LICENSES.md | 8 ++++++ README.md | 10 +++++++ SECURITY.md | 10 +++++++ hk.pkl | 23 ++++++++++++++++ mise.toml | 29 ++++++++++++++++++++ renovate.json | 7 +++++ 13 files changed, 308 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/rfc.yml create mode 100644 .github/ISSUE_TEMPLATE/task.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/workflows/guardrails.yml create mode 100644 CONTRIBUTING.md create mode 100644 LICENSES.md create mode 100644 SECURITY.md create mode 100644 hk.pkl create mode 100644 mise.toml create mode 100644 renovate.json diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..4cc977f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,44 @@ +name: Bug report +description: Report behavior that is broken, incorrect, or unexpectedly failing. +title: "fix: " +body: + - type: markdown + attributes: + value: | + Use this for reproducible defects. Keep secrets, real local session data, and private logs out of public issues. + - type: textarea + id: current-behavior + attributes: + label: Current behavior + description: What happens now? + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: What should happen instead? + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Reproduction steps + description: Minimal steps a maintainer can run to reproduce the bug. + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment + description: OS, runtime versions, branch/commit, and affected package or command. + validations: + required: true + - type: textarea + id: acceptance-criteria + attributes: + label: Acceptance criteria + description: Observable outcomes that prove the bug is fixed. + validations: + required: false + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..549e964 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +blank_issues_enabled: false +contact_links: + - name: Private security report + url: https://github.com/agent-trail/spec/security/advisories/new + about: Report vulnerabilities privately instead of opening a public issue. + diff --git a/.github/ISSUE_TEMPLATE/rfc.yml b/.github/ISSUE_TEMPLATE/rfc.yml new file mode 100644 index 0000000..c50a6b4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/rfc.yml @@ -0,0 +1,44 @@ +name: RFC / spec decision +description: Propose a load-bearing Agent Trail format, schema, validation, package layout, or architecture decision. +title: "rfc: " +body: + - type: markdown + attributes: + value: | + Use this before changing load-bearing shape such as normative format or schema semantics, validation terminology or behavior, versioning, hash semantics, artifact identity, package layout, durable architecture, or public URL shape. + - type: textarea + id: problem + attributes: + label: Problem or decision + description: What decision needs to be made, and why now? + validations: + required: true + - type: textarea + id: affected-surface + attributes: + label: Affected contract surface + description: Name the spec section, schema path, package API, CLI behavior, docs, ADRs, fixtures, or public URLs affected. + validations: + required: true + - type: textarea + id: proposal + attributes: + label: Proposal + description: State the exact rule or direction to adopt. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives considered + description: List plausible options and tradeoffs. + validations: + required: true + - type: textarea + id: acceptance-criteria + attributes: + label: Acceptance criteria + description: Observable outcomes that prove the decision has been implemented. + validations: + required: true + diff --git a/.github/ISSUE_TEMPLATE/task.yml b/.github/ISSUE_TEMPLATE/task.yml new file mode 100644 index 0000000..8d19bdf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task.yml @@ -0,0 +1,44 @@ +name: Task or feature +description: Request a scoped implementation task, feature, refactor, or docs update. +title: "feat: " +body: + - type: markdown + attributes: + value: | + Use this for work that should be implementable by a human or coding agent from the issue alone. + - type: textarea + id: goal + attributes: + label: Goal + description: What should be true when this is done? + validations: + required: true + - type: textarea + id: scope + attributes: + label: Scope + description: What is included? + validations: + required: true + - type: textarea + id: non-goals + attributes: + label: Non-goals + description: What should not be changed or added? + validations: + required: false + - type: textarea + id: acceptance-criteria + attributes: + label: Acceptance criteria + description: Observable outcomes that prove the task is complete. + validations: + required: true + - type: textarea + id: verification + attributes: + label: Verification + description: Commands or checks that should pass. + validations: + required: true + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..e320561 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,20 @@ +## Summary + +- + +## Public Impact + +- [ ] No public contract change +- [ ] Spec or schema change +- [ ] Public package API change +- [ ] CLI behavior change +- [ ] Public URL or docs behavior change + +## Verification + +- + +## Reviewer Notes + +- + diff --git a/.github/workflows/guardrails.yml b/.github/workflows/guardrails.yml new file mode 100644 index 0000000..6971b75 --- /dev/null +++ b/.github/workflows/guardrails.yml @@ -0,0 +1,21 @@ +name: guardrails + +on: + pull_request: + push: + branches: + - main + +permissions: + contents: read + +jobs: + guardrails: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4 + with: + persist-credentials: false + - uses: jdx/mise-action@5228313ee0372e111a38da051671ca30fc5a96db # v3 + - name: Run repository checks + run: mise run check diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..03233d5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,42 @@ +# Contributing + +Agent Trail work is tracked in Linear and implemented through pull requests. + +## Workflow + +- Start from a Linear issue or accepted maintainer direction. +- Keep changes scoped to the active issue. +- Use Conventional Commit subjects for commits and pull request titles. +- Do not include agent attribution in commits, pull request bodies, generated docs, or code comments. +- Do not commit real local sessions, secrets, credentials, tokens, private logs, or unredacted user data. + +## Local Setup + +Install tools and hooks: + +```sh +mise install +mise run hooks:install +``` + +Common tasks: + +```sh +mise run check +mise run lint +mise run test +``` + +`mise` is the repo entrypoint for tools and tasks. `hk` owns Git hooks and project lint gates. + +## Pull Requests + +Before opening a pull request: + +- Run `mise run check`. +- Link the Linear issue. +- State public spec, schema, package API, CLI, or URL impact. +- Include exact verification commands and results. + +Pull requests are squash-merged. Keep branches narrow and delete them after merge. + diff --git a/LICENSES.md b/LICENSES.md new file mode 100644 index 0000000..836c024 --- /dev/null +++ b/LICENSES.md @@ -0,0 +1,8 @@ +# Licensing + +This repository contains the Agent Trail format contract. + +Unless otherwise noted, specification prose, schema artifacts, fixtures, ADRs, and documentation in this repository are licensed under Apache-2.0. + +Implementation repositories in the Agent Trail organization use MIT unless their own `LICENSES.md` says otherwise. + diff --git a/README.md b/README.md index dd4711c..5bf15d0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,12 @@ # spec Agent Trail format specification, schema artifacts, fixtures, and format ADRs. + +## Development + +```sh +mise install +mise run hooks:install +mise run check +``` + +See `CONTRIBUTING.md` for workflow and PR expectations. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..ffd7b21 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,10 @@ +# Security + +Do not open public issues for vulnerabilities. + +Use GitHub private vulnerability reporting: + +https://github.com/agent-trail/spec/security/advisories/new + +Do not include secrets, credentials, private local paths, or unredacted session data in reports unless they are necessary to reproduce the issue. + diff --git a/hk.pkl b/hk.pkl new file mode 100644 index 0000000..b69058f --- /dev/null +++ b/hk.pkl @@ -0,0 +1,23 @@ +amends "package://github.com/jdx/hk/releases/download/v1.47.0/hk@1.47.0#/Config.pkl" +import "package://github.com/jdx/hk/releases/download/v1.47.0/hk@1.47.0#/Builtins.pkl" + +local linters = new Mapping { + ["actionlint"] = Builtins.actionlint + ["zizmor"] { + glob = List(".github/workflows/*.yml", ".github/workflows/*.yaml") + check = "zizmor .github/workflows" + } +} + +hooks { + ["pre-commit"] { + steps = linters + } + ["pre-push"] { + steps = linters + } + ["check"] { + steps = linters + } +} + diff --git a/mise.toml b/mise.toml new file mode 100644 index 0000000..06b3c38 --- /dev/null +++ b/mise.toml @@ -0,0 +1,29 @@ +[tools] +"aqua:jdx/hk" = "1.47.0" +"aqua:rhysd/actionlint" = "1.7.12" +"aqua:zizmorcore/zizmor" = "1.25.2" + +[tasks.setup] +description = "Install tools and configure Git hooks" +depends = ["hooks:install"] + +[tasks."hooks:install"] +description = "Install hk Git hooks" +run = "hk install" + +[tasks.check] +description = "Run all repository checks" +depends = ["lint", "test"] + +[tasks.lint] +description = "Run project lint gates" +run = "hk check" + +[tasks.test] +description = "Run tests for this repository" +run = "echo 'No tests configured yet.'" + +[tasks."check:actions"] +description = "Validate GitHub Actions workflows" +run = "actionlint && zizmor .github/workflows" + diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..057c514 --- /dev/null +++ b/renovate.json @@ -0,0 +1,7 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": ["config:recommended"], + "labels": ["dependencies"], + "timezone": "Asia/Kolkata" +} + From a800f188052b4f77575f746913e34e17955e6d07 Mon Sep 17 00:00:00 2001 From: Somasundaram Ayyappan <1802828+somus@users.noreply.github.com> Date: Fri, 12 Jun 2026 15:56:06 +0530 Subject: [PATCH 02/11] chore: address review feedback --- .github/PULL_REQUEST_TEMPLATE.md | 3 ++- .github/workflows/guardrails.yml | 4 ++++ CONTRIBUTING.md | 4 +--- README.md | 3 +-- mise.toml | 3 +-- renovate.json | 4 +--- 6 files changed, 10 insertions(+), 11 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e320561..656a954 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,3 +1,5 @@ +# Pull Request + ## Summary - @@ -17,4 +19,3 @@ ## Reviewer Notes - - diff --git a/.github/workflows/guardrails.yml b/.github/workflows/guardrails.yml index 6971b75..8e40a50 100644 --- a/.github/workflows/guardrails.yml +++ b/.github/workflows/guardrails.yml @@ -9,6 +9,10 @@ on: permissions: contents: read +concurrency: + group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} + cancel-in-progress: true + jobs: guardrails: runs-on: ubuntu-latest diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 03233d5..28d57b1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,8 +15,7 @@ Agent Trail work is tracked in Linear and implemented through pull requests. Install tools and hooks: ```sh -mise install -mise run hooks:install +mise run setup ``` Common tasks: @@ -39,4 +38,3 @@ Before opening a pull request: - Include exact verification commands and results. Pull requests are squash-merged. Keep branches narrow and delete them after merge. - diff --git a/README.md b/README.md index 5bf15d0..25298cd 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,7 @@ Agent Trail format specification, schema artifacts, fixtures, and format ADRs. ## Development ```sh -mise install -mise run hooks:install +mise run setup mise run check ``` diff --git a/mise.toml b/mise.toml index 06b3c38..40da695 100644 --- a/mise.toml +++ b/mise.toml @@ -25,5 +25,4 @@ run = "echo 'No tests configured yet.'" [tasks."check:actions"] description = "Validate GitHub Actions workflows" -run = "actionlint && zizmor .github/workflows" - +run = "if [ -d .github/workflows ]; then actionlint && zizmor .github/workflows; else echo 'No GitHub Actions workflows configured.'; fi" diff --git a/renovate.json b/renovate.json index 057c514..6dc7957 100644 --- a/renovate.json +++ b/renovate.json @@ -1,7 +1,5 @@ { "$schema": "https://docs.renovatebot.com/renovate-schema.json", "extends": ["config:recommended"], - "labels": ["dependencies"], - "timezone": "Asia/Kolkata" + "labels": ["dependencies"] } - From e76a0b0aef3b8ba64239d8ae2dd6f702e476fc04 Mon Sep 17 00:00:00 2001 From: Somasundaram Ayyappan <1802828+somus@users.noreply.github.com> Date: Fri, 12 Jun 2026 15:57:43 +0530 Subject: [PATCH 03/11] chore: normalize issue templates --- .github/ISSUE_TEMPLATE/bug.yml | 1 - .github/ISSUE_TEMPLATE/config.yml | 1 - .github/ISSUE_TEMPLATE/rfc.yml | 1 - .github/ISSUE_TEMPLATE/task.yml | 1 - 4 files changed, 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 4cc977f..d102922 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -41,4 +41,3 @@ body: description: Observable outcomes that prove the bug is fixed. validations: required: false - diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 549e964..e58a9ac 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -3,4 +3,3 @@ contact_links: - name: Private security report url: https://github.com/agent-trail/spec/security/advisories/new about: Report vulnerabilities privately instead of opening a public issue. - diff --git a/.github/ISSUE_TEMPLATE/rfc.yml b/.github/ISSUE_TEMPLATE/rfc.yml index c50a6b4..9ea56e9 100644 --- a/.github/ISSUE_TEMPLATE/rfc.yml +++ b/.github/ISSUE_TEMPLATE/rfc.yml @@ -41,4 +41,3 @@ body: description: Observable outcomes that prove the decision has been implemented. validations: required: true - diff --git a/.github/ISSUE_TEMPLATE/task.yml b/.github/ISSUE_TEMPLATE/task.yml index 8d19bdf..11725e0 100644 --- a/.github/ISSUE_TEMPLATE/task.yml +++ b/.github/ISSUE_TEMPLATE/task.yml @@ -41,4 +41,3 @@ body: description: Commands or checks that should pass. validations: required: true - From f5395e665cc7dd561cfb00aad6112961f0495478 Mon Sep 17 00:00:00 2001 From: Somasundaram Ayyappan <1802828+somus@users.noreply.github.com> Date: Fri, 12 Jun 2026 16:14:15 +0530 Subject: [PATCH 04/11] docs: add agent instructions --- AGENTS.md | 24 ++++++++++++++++++++++++ CLAUDE.md | 1 + 2 files changed, 25 insertions(+) create mode 100644 AGENTS.md create mode 120000 CLAUDE.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..2693a72 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,24 @@ +# Agent Instructions + +This repo owns the Agent Trail format specification, schema artifacts, fixtures, and format ADRs. + +## Workflow + +- Start from the linked Linear issue or maintainer direction. +- Keep changes scoped to this repo's public spec, schema, fixture, or documentation surface. +- Do not add implementation-only contracts to the format spec. +- Do not commit real local sessions, secrets, credentials, private logs, or unredacted user data. +- Do not include agent attribution in commits, pull request bodies, generated docs, or code comments. + +## Commands + +- Use `mise run setup` for local tool and hook setup. +- Use `mise run check` before opening or updating a pull request. +- Use `mise run check:actions` after editing GitHub Actions workflows. + +## Pull Requests + +- Use `.github/PULL_REQUEST_TEMPLATE.md`. +- Link the Linear issue. +- State public spec, schema, fixture, or docs impact. +- Include exact verification commands and results. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 120000 index 0000000..47dc3e3 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +AGENTS.md \ No newline at end of file From dd5315e5621ae562e38559eaf2f9cf4b212e708e Mon Sep 17 00:00:00 2001 From: Somasundaram Ayyappan <1802828+somus@users.noreply.github.com> Date: Fri, 12 Jun 2026 18:22:29 +0530 Subject: [PATCH 05/11] docs: trim agent instructions --- AGENTS.md | 1 - 1 file changed, 1 deletion(-) diff --git a/AGENTS.md b/AGENTS.md index 2693a72..86374f5 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -8,7 +8,6 @@ This repo owns the Agent Trail format specification, schema artifacts, fixtures, - Keep changes scoped to this repo's public spec, schema, fixture, or documentation surface. - Do not add implementation-only contracts to the format spec. - Do not commit real local sessions, secrets, credentials, private logs, or unredacted user data. -- Do not include agent attribution in commits, pull request bodies, generated docs, or code comments. ## Commands From ad67330bec87d8239028c3661e2058d40ac5b4ee Mon Sep 17 00:00:00 2001 From: Somasundaram Ayyappan <1802828+somus@users.noreply.github.com> Date: Fri, 12 Jun 2026 18:53:13 +0530 Subject: [PATCH 06/11] chore: update tool pins --- .github/workflows/guardrails.yml | 4 ++-- hk.pkl | 5 ++--- mise.toml | 2 +- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/.github/workflows/guardrails.yml b/.github/workflows/guardrails.yml index 8e40a50..a3487eb 100644 --- a/.github/workflows/guardrails.yml +++ b/.github/workflows/guardrails.yml @@ -17,9 +17,9 @@ jobs: guardrails: runs-on: ubuntu-latest steps: - - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4 + - uses: actions/checkout@9f698171ed81b15d1823a05fc7211befd50c8ae0 # v6.0.3 with: persist-credentials: false - - uses: jdx/mise-action@5228313ee0372e111a38da051671ca30fc5a96db # v3 + - uses: jdx/mise-action@dba19683ed58901619b14f395a24841710cb4925 # v4.1.0 - name: Run repository checks run: mise run check diff --git a/hk.pkl b/hk.pkl index b69058f..68e6af5 100644 --- a/hk.pkl +++ b/hk.pkl @@ -1,5 +1,5 @@ -amends "package://github.com/jdx/hk/releases/download/v1.47.0/hk@1.47.0#/Config.pkl" -import "package://github.com/jdx/hk/releases/download/v1.47.0/hk@1.47.0#/Builtins.pkl" +amends "package://github.com/jdx/hk/releases/download/v1.48.0/hk@1.48.0#/Config.pkl" +import "package://github.com/jdx/hk/releases/download/v1.48.0/hk@1.48.0#/Builtins.pkl" local linters = new Mapping { ["actionlint"] = Builtins.actionlint @@ -20,4 +20,3 @@ hooks { steps = linters } } - diff --git a/mise.toml b/mise.toml index 40da695..685bd2a 100644 --- a/mise.toml +++ b/mise.toml @@ -1,5 +1,5 @@ [tools] -"aqua:jdx/hk" = "1.47.0" +"aqua:jdx/hk" = "1.48.0" "aqua:rhysd/actionlint" = "1.7.12" "aqua:zizmorcore/zizmor" = "1.25.2" From 3676dcbf5a0eb68e5251ee8e09cf52baffa99f2c Mon Sep 17 00:00:00 2001 From: Somasundaram Ayyappan <1802828+somus@users.noreply.github.com> Date: Fri, 12 Jun 2026 18:56:29 +0530 Subject: [PATCH 07/11] docs: clarify contributor guidance --- AGENTS.md | 4 ++++ CONTRIBUTING.md | 20 +++++++++++--------- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 86374f5..a1cd79f 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -15,6 +15,10 @@ This repo owns the Agent Trail format specification, schema artifacts, fixtures, - Use `mise run check` before opening or updating a pull request. - Use `mise run check:actions` after editing GitHub Actions workflows. +## Dependencies and Tools + +- Before introducing a package, tool, or GitHub Action, check the latest upstream stable version and use it unless there is a documented reason not to. + ## Pull Requests - Use `.github/PULL_REQUEST_TEMPLATE.md`. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 28d57b1..7332e69 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,12 @@ # Contributing -Agent Trail work is tracked in Linear and implemented through pull requests. +Thanks for helping improve Agent Trail. -## Workflow +## Before You Start -- Start from a Linear issue or accepted maintainer direction. -- Keep changes scoped to the active issue. -- Use Conventional Commit subjects for commits and pull request titles. -- Do not include agent attribution in commits, pull request bodies, generated docs, or code comments. -- Do not commit real local sessions, secrets, credentials, tokens, private logs, or unredacted user data. +- Open or pick up a Linear issue before starting larger changes. +- Keep pull requests focused on one problem. +- Avoid committing real local sessions, secrets, credentials, tokens, private logs, or unredacted user data. ## Local Setup @@ -26,7 +24,11 @@ mise run lint mise run test ``` -`mise` is the repo entrypoint for tools and tasks. `hk` owns Git hooks and project lint gates. +`mise` installs repo tools and runs tasks. `hk` owns local Git hooks. + +## Dependencies and Tools + +When adding a package, tool, or GitHub Action, check the latest stable upstream version first. Use the latest version by default; if you pin an older version, explain why in the pull request. ## Pull Requests @@ -34,7 +36,7 @@ Before opening a pull request: - Run `mise run check`. - Link the Linear issue. -- State public spec, schema, package API, CLI, or URL impact. +- Summarize the spec, schema, fixture, or docs impact. - Include exact verification commands and results. Pull requests are squash-merged. Keep branches narrow and delete them after merge. From 6f5ed6eb9d98af76e85defda55482aa381820870 Mon Sep 17 00:00:00 2001 From: Somasundaram Ayyappan <1802828+somus@users.noreply.github.com> Date: Fri, 12 Jun 2026 19:03:18 +0530 Subject: [PATCH 08/11] docs: add repo branding and license --- LICENSE | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++++ LICENSES.md | 8 ------ README.md | 11 +++++++-- 3 files changed, 80 insertions(+), 10 deletions(-) create mode 100644 LICENSE delete mode 100644 LICENSES.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4d24624 --- /dev/null +++ b/LICENSE @@ -0,0 +1,71 @@ +Apache License +Version 2.0, January 2004 +http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + +"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. + +"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. + +"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. + +"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. + +"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. + +"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. + +"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work. + +"Derivative Works" shall mean any work, whether in Source or Object form, that is based on or derived from the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link or bind by name to the interfaces of, the Work and Derivative Works thereof. + +"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems managed by, or on behalf of, the Licensor for discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." + +"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. + +2. Grant of Copyright License. + +Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. + +Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to patent claims licensable by such Contributor that are necessarily infringed by their Contribution alone or by combination of their Contribution with the Work to which such Contribution was submitted. If You institute patent litigation against any entity, including a cross-claim or counterclaim in a lawsuit, alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. + +4. Redistribution. + +You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: + +(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and + +(b) You must cause any modified files to carry prominent notices stating that You changed the files; and + +(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and + +(d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. + +You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. + +5. Submission of Contributions. + +Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement You may have executed with Licensor regarding such Contributions. + +6. Trademarks. + +This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. + +Unless required by applicable law or agreed to in writing, Licensor provides the Work on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. + +In no event and under no legal theory, whether in tort, including negligence, contract, or otherwise, unless required by applicable law, such as deliberate and grossly negligent acts, or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work, including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses, even if such Contributor has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. + +While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of Your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS diff --git a/LICENSES.md b/LICENSES.md deleted file mode 100644 index 836c024..0000000 --- a/LICENSES.md +++ /dev/null @@ -1,8 +0,0 @@ -# Licensing - -This repository contains the Agent Trail format contract. - -Unless otherwise noted, specification prose, schema artifacts, fixtures, ADRs, and documentation in this repository are licensed under Apache-2.0. - -Implementation repositories in the Agent Trail organization use MIT unless their own `LICENSES.md` says otherwise. - diff --git a/README.md b/README.md index 25298cd..46bb419 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ -# spec -Agent Trail format specification, schema artifacts, fixtures, and format ADRs. +# Agent Trail Spec + +Open interchange format contract for coding-agent session trails. + +This repository contains the Agent Trail specification, JSON Schema artifacts, fixtures, and format ADRs. ## Development @@ -9,3 +12,7 @@ mise run check ``` See `CONTRIBUTING.md` for workflow and PR expectations. + +## License + +Apache-2.0. See `LICENSE`. From 5ddf7c75d1d250b95612d705f03ff71188adebd4 Mon Sep 17 00:00:00 2001 From: Somasundaram Ayyappan <1802828+somus@users.noreply.github.com> Date: Fri, 12 Jun 2026 19:12:46 +0530 Subject: [PATCH 09/11] docs: link related repositories --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 46bb419..c4bbf6e 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,15 @@ Open interchange format contract for coding-agent session trails. This repository contains the Agent Trail specification, JSON Schema artifacts, fixtures, and format ADRs. +## Related Repositories + +Agent Trail is split across focused repositories: + +- [agent-trail/spec](https://github.com/agent-trail/spec) - format contract, JSON Schema, fixtures, and format ADRs. +- [agent-trail/typescript-sdk](https://github.com/agent-trail/typescript-sdk) - TypeScript packages for Agent Trail files. +- [agent-trail/cli](https://github.com/agent-trail/cli) - command-line tools for Agent Trail workflows. +- [agent-trail/web](https://github.com/agent-trail/web) - docs site and shared trail web viewer. + ## Development ```sh From 64b779820c0419345b963610a7047ae68fb89b1f Mon Sep 17 00:00:00 2001 From: Somasundaram Ayyappan <1802828+somus@users.noreply.github.com> Date: Fri, 12 Jun 2026 21:04:33 +0530 Subject: [PATCH 10/11] docs: adapt contributing for external contributors --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7332e69..a8c388e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Thanks for helping improve Agent Trail. ## Before You Start -- Open or pick up a Linear issue before starting larger changes. +- For larger changes, open a GitHub issue or discussion first so maintainers can agree on scope. - Keep pull requests focused on one problem. - Avoid committing real local sessions, secrets, credentials, tokens, private logs, or unredacted user data. @@ -35,7 +35,7 @@ When adding a package, tool, or GitHub Action, check the latest stable upstream Before opening a pull request: - Run `mise run check`. -- Link the Linear issue. +- Link the relevant GitHub issue or discussion, if one exists. - Summarize the spec, schema, fixture, or docs impact. - Include exact verification commands and results. From 97ff3cbfb65b67ccfb0bb7a462628080287c0391 Mon Sep 17 00:00:00 2001 From: Somasundaram Ayyappan <1802828+somus@users.noreply.github.com> Date: Fri, 12 Jun 2026 21:27:06 +0530 Subject: [PATCH 11/11] ci: include workflow checks --- .github/PULL_REQUEST_TEMPLATE.md | 8 ++++++++ mise.toml | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 656a954..9ae7d85 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,6 +4,10 @@ - +## Related Issue + +- + ## Public Impact - [ ] No public contract change @@ -12,6 +16,10 @@ - [ ] CLI behavior change - [ ] Public URL or docs behavior change +Impact description: + +- + ## Verification - diff --git a/mise.toml b/mise.toml index 685bd2a..10192f5 100644 --- a/mise.toml +++ b/mise.toml @@ -13,7 +13,7 @@ run = "hk install" [tasks.check] description = "Run all repository checks" -depends = ["lint", "test"] +depends = ["lint", "test", "check:actions"] [tasks.lint] description = "Run project lint gates"