Skip to content

Commit f25dfcb

Browse files
committed
Add LLM guidelines
1 parent dd4fc13 commit f25dfcb

File tree

9 files changed

+44
-0
lines changed

9 files changed

+44
-0
lines changed

.augment-guidelines

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.llmrules

.clinerules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.llmrules

.cursorrules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.llmrules

.github/copilot-instructions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../.llmrules

.llmrules

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Reverse Image Search WebExtension
2+
3+
## Overview
4+
5+
- WebExtension which adds an option to the context menu to search with an image on various services
6+
- Code is written in TypeScript
7+
- UI is built with Svelte 4
8+
- Linted with Biome
9+
- Tested with Vitest
10+
- Built with web-ext
11+
12+
## Source code structure
13+
14+
- `source/`: Source code
15+
- `service-worker/`: Service worker code
16+
- `options/`: Options page
17+
- `components/`: Svelte components
18+
- `stores/`: Svelte stores
19+
- `App.svelte`: Main Svelte component
20+
- `options.scss`: Stylesheet
21+
- `options.ts`: For initialization of Svelte
22+
- `public/`: Built code
23+
- `build/`: Built JavaScript and CSS
24+
- `_locales/`: Localizations
25+
- `manifest.json`: Manifest
26+
- `icons/`: Icons
27+
28+
## Build
29+
30+
Build with `npm run build`. Never run the `start:BROWSER` commands, the user will do it manually. Lint with the `npm run lint:types` for TypeScript and `npm run lint:code` for Biome. Do not use `npm run dev` as it will start a long running watch commands - just use `npm run build`.
31+
32+
## Important to note
33+
34+
For every string, add the localization to `public/_locales/LOCALE/messages.json` and use the `getMessage` function to retrieve it. Do not hardcode any strings in the code. Translate the strings in all languages. For German, use the informal (Du) version.
35+
36+
Only add tests for core code and when neccessary. Do not test Svelte components.

.windsurfrules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.llmrules

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.llmrules

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.llmrules

GEMINI.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.llmrules

0 commit comments

Comments
 (0)