Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 1 addition & 7 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
## Copilot Instructions for ScyllaDB Operator

Follow the project's [CONTRIBUTING.md](../CONTRIBUTING.md) and [API_CONVENTIONS.md](../API_CONVENTIONS.md).

### Commits and PRs

- 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.
- 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.
- If the PR fixes an issue, reference it with `Resolves #<number>` only in the PR description.
Comment thread
rzetelskik marked this conversation as resolved.
Read and follow the instructions in [AGENTS.md](AGENTS.md) and all referred files in it for the project conventions and guidelines.
11 changes: 11 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# AGENTS.md
Comment thread
rzetelskik marked this conversation as resolved.

This file provides instructions for AI coding agents contributing to this repository.

## Guidelines

Read and follow these documents before making changes:

- [CONTRIBUTING.md](CONTRIBUTING.md) — development setup, build and test commands, coding conventions, commit and PR requirements.
- [API_CONVENTIONS.md](API_CONVENTIONS.md) — API design patterns for CRD types.

Comment thread
rzetelskik marked this conversation as resolved.
3 changes: 3 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Claude Code Instructions

Read and follow the instructions in [AGENTS.md](AGENTS.md) and all referred files in it for the project conventions and guidelines.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,12 @@ Once you have implemented the feature or bug fix in your branch, open a PR to th
- Your commit history is clean.
- Your commit message and PR title follow the guidelines outlined in this section.
- If your changes are user-facing, you have added an appropriate entry to the changelog.
- If the PR fixes an issue, reference it with `Resolves #<number>` only in the PR description.

### Commit History

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.
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.

### Commits and PRs

Expand Down