From 80c24b30b118a98f577035e0ac9157c3270e0cb6 Mon Sep 17 00:00:00 2001 From: vklimontovich Date: Thu, 16 Apr 2026 20:49:42 -0400 Subject: [PATCH] chore: add CONTRIBUTING.md, AGENTS.md and CLAUDE.md --- AGENTS.md | 5 +++++ CLAUDE.md | 1 + CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ 3 files changed, 34 insertions(+) create mode 100644 AGENTS.md create mode 120000 CLAUDE.md create mode 100644 CONTRIBUTING.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..154917b --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,5 @@ +# Agent Guidelines + +When you need to create branches, make commits, or open pull requests, read +[CONTRIBUTING.md](CONTRIBUTING.md) first. No need to read it for code exploration — +only when interacting with git. 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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..cd22f60 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# Contributing + +## Overview + +This repo contains the shared AI review GitHub Actions workflow used across Jitsu repos. + +## Development Branch + +The default development branch is `main`. + +## Common Principles + +**Branch naming:** Use a type prefix — `feat/`, `fix/`, `chore/`. +Example: `feat/add-security-checks`. + +**Merging policy:** We avoid merge commits. Always rebase onto the default branch — +never merge the default branch into a branch. For PRs, merge with full history preserved +— no squash merge. It's fine to squash overly granular commits within a branch locally +before opening a PR. + +**Commit style:** [Conventional commits](https://www.conventionalcommits.org/) — +`type(scope): description`. Common types: `fix`, `feat`, `chore`, `refactor`, `ci`. + +## PRs vs Direct Commits + +Trivial changes, bug fixes, and config updates go directly to `main`. Larger or riskier +changes use pull requests. The engineer decides based on complexity and risk. AI review +runs on every push and PR.