Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 35cb7c72 authored by Paula's avatar Paula
Browse files

add agents instruction & remove old comment

parent 90851099
Loading
Loading
Loading
Loading

AGENTS.md

0 → 100644
+60 −0
Original line number Diff line number Diff line
# Agent Instructions

## Language

- Write all code and comments in English

## Naming conventions

- `my-class` — CSS classes use kebab-case
- `camelCase` — variables
- `$variableName` — DOM Node variables are prefixed with `$`
- `MAJUSCULE` — global constants use UPPERCASE

## File conventions

- `object.manager.js` — directive class coordinating sub-classes or views
- `object.class.js` — single-responsibility class used by a manager

## Function & JSDoc conventions

- Add a blank line between each function
- Any function created by an agent must include a JSDoc block with:
  - A function description
  - Parameters with their types
  - Return value with its type
- Use JSDoc for all functions with this format:
  - `/** Description. */`
  - `@param {Type} paramName Description.`
  - `@returns {Type} Description.`
- For functions returning nothing, use `@returns {void}`
- For optional parameters, use `@param {Type} [paramName] Description.`

## Async conventions

- Do not leave floating promises
- Prefer `async/await` over chained `.then()` calls

## Import conventions

- Group imports in this order:
  - External dependencies
  - Internal modules
  - Styles and assets
- Keep imports sorted within each group

## UI text conventions

- Do not hardcode user-facing strings in views
- Use translation keys and language files in `app/public/assets/languages/*.json`

## Validation conventions

Run the formatter from the `app/` directory before finishing:

- After code changes, run:
  - `cd app && npm run format`
  - `cd app && npm run check`

## Canary test
- If the user writes "canary", answer exactly: "AGENTS_OK"
 No newline at end of file
+0 −3
Original line number Diff line number Diff line
@@ -105,7 +105,6 @@ export default class ViewManager {
    const $total = document.getElementById("total-step");
    $total.innerText = total;
  }
  // BUTTON EVENTS

  /**
   * Executes a user step and manages the visual state of its button.
@@ -183,8 +182,6 @@ export default class ViewManager {
   */
  onStepFailed() {}

  // /BUTTON EVENTS

  /**
   * Updates the download progress in the UI.
   *