Skip to content

Commit d12a001

Browse files
committed
chore(ai): add AGENTS.md to improve assisted contributions
1 parent 4b2ad6b commit d12a001

4 files changed

Lines changed: 21 additions & 7 deletions

File tree

.github/copilot-instructions.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
11
## Copilot Instructions for ScyllaDB Operator
22

3-
Follow the project's [CONTRIBUTING.md](../CONTRIBUTING.md) and [API_CONVENTIONS.md](../API_CONVENTIONS.md).
4-
5-
### Commits and PRs
6-
7-
- Format commit messages and PR titles as [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/): `<type>(<scope>): <subject>` or `<type>: <scopeless subject>`, where subject is imperative, lowercase, ≤72 chars, and has no trailing period.
8-
- Never include `@mentions`, [keywords that close issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue) or hashtag ("#") references in the commit messages.
9-
- If the PR fixes an issue, reference it with `Resolves #<number>` only in the PR description.
3+
Read and follow the instructions in [AGENTS.md](AGENTS.md) and all referred files in it for the project conventions and guidelines.

AGENTS.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# AGENTS.md
2+
3+
This file provides instructions for AI coding agents contributing to this repository.
4+
5+
## Project Overview
6+
7+
scylla-operator is a Kubernetes operator for managing ScyllaDB clusters, written in Go using controller-runtime patterns.
8+
9+
## Guidelines
10+
11+
Read and follow these documents before making changes:
12+
13+
- [CONTRIBUTING.md](CONTRIBUTING.md) — development setup, build and test commands, coding conventions, commit and PR requirements.
14+
- [API_CONVENTIONS.md](API_CONVENTIONS.md) — API design patterns for CRD types.
15+

CLAUDE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Claude Code Instructions
2+
3+
Read and follow the instructions in [AGENTS.md](AGENTS.md) and all referred files in it for the project conventions and guidelines.

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,12 @@ Once you have implemented the feature or bug fix in your branch, open a PR to th
103103
- Your commit history is clean.
104104
- Your commit message and PR title follow the guidelines outlined in this section.
105105
- If your changes are user-facing, you have added an appropriate entry to the changelog.
106+
- If the PR fixes an issue, reference it with `Resolves #<number>` only in the PR description.
106107

107108
### Commit History
108109

109110
To maintain a clean commit history, aim for a minimal number of logical commits. Typically, this means a single commit that contains all the changes, with a separate commit for autogenerated parts.
111+
Never include `@mentions`, [keywords that close issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue) or hashtag ("#") references in the commit messages.
110112

111113
### Commits and PRs
112114

0 commit comments

Comments
 (0)