Skip to content

chore: add AGENTS.md for agentic coding assistance#3163

Open
abraemer wants to merge 10 commits into
mainfrom
chore/add-agents-md
Open

chore: add AGENTS.md for agentic coding assistance#3163
abraemer wants to merge 10 commits into
mainfrom
chore/add-agents-md

Conversation

@abraemer

@abraemer abraemer commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Adds a compact AGENTS.md instruction file to help future agentic coding sessions (OpenCode, etc.) ramp up quickly and avoid common mistakes in this repo.

Covers:

  • Architecture overview (two tsconfig projects, ElectronBackend/Frontend/shared boundaries)
  • Exact dev commands and the full CI verification sequence
  • Critical quirks (dual better-sqlite3 builds, generated DB files, REUSE copyright headers, Node version pinning)
  • Commit conventions (conventional commits + DCO sign-off)
  • Pre-commit hook behavior
  • ESLint rules most likely to trip up agents
  • Vitest project layout and E2E testing setup
  • Style conventions

abraemer added 7 commits June 17, 2026 13:03
Signed-off-by: Adrian Braemer <adrian.braemer@tngtech.com>
Signed-off-by: Adrian Braemer <adrian.braemer@tngtech.com>
Signed-off-by: Adrian Braemer <adrian.braemer@tngtech.com>
Signed-off-by: Adrian Braemer <adrian.braemer@tngtech.com>
Signed-off-by: Adrian Braemer <adrian.braemer@tngtech.com>
Signed-off-by: Adrian Braemer <adrian.braemer@tngtech.com>
Signed-off-by: Adrian Braemer <adrian.braemer@tngtech.com>
Signed-off-by: Adrian Braemer <adrian.braemer@tngtech.com>
@abraemer abraemer force-pushed the chore/add-agents-md branch from 73c2b5c to 6370bdd Compare June 17, 2026 13:39
abraemer added 2 commits June 17, 2026 15:50
…kers

Signed-off-by: Adrian Braemer <adrian.braemer@tngtech.com>
Signed-off-by: Adrian Braemer <adrian.braemer@tngtech.com>
SPDX-License-Identifier: CC0-1.0
-->

<!-- REUSE-IgnoreStart -->

@mariusAsaTNG mariusAsaTNG Jul 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only file with -- REUSE-IgnoreStart --

@mariusAsaTNG mariusAsaTNG left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

About time we add some agentic coding assistance files 👍


CI runs `yarn lint-commits` which checks every commit in the PR against
`origin/main`. All commits in the branch must follow conventional commit format,
not just the latest one.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally I do not want AI to do commits for me, especially with signing enabled, but I will not stand in the way of this doc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants