Skip to content

agents.md: Add rules on JSDocs and settings creation #2410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rafaellehmkuhl wants to merge 2 commits into
base: master
Choose a base branch
from
Open

agents.md: Add rules on JSDocs and settings creation #2410

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d16c93
agents.md: Instruct to never add empty JSDoc entries
rafaellehmkuhl Feb 13, 2026
b13f394
agents.md: Instruct it to not allow settings without the `cockpit-` p…
rafaellehmkuhl Feb 13, 2026
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
4 changes: 3 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ gh issue list --repo bluerobotics/cockpit
- Use examples when needed, specially when implementing complex logics
- Always create docs for the @returns, unless when
- Always include the types of the @returns and @params
- Make sure none of the added entries you added in the JSDocs are empty

## Code Quality

Expand All @@ -71,4 +72,5 @@ This command fixes all the linting issues that are automatically fixable, but it
> **Important:** Always use `yarn` for frontend commands, never `npx`, `npm` or others.

- If implementing a feature that needs cannot be fully supported in both Standalone (Electron) and Lite (Web) version, the limitations should be specified in the `README.md` table, and there should exist information elements in the UI explaining that to the users.
- When implementing new widgets, or adding/removing entries in the Options object of existing widgets, use the object merging approach (use `src/components/widgets/Plotter.vue` as a reference) to merge a default-options object with the persistent one. This ensures the new entries are added to existing widgets from the users persistence.
- When implementing new widgets, or adding/removing entries in the Options object of existing widgets, use the object merging approach (use `src/components/widgets/Plotter.vue` as a reference) to merge a default-options object with the persistent one. This ensures the new entries are added to existing widgets from the users persistence.
- If a new Cockpit local-storage setting is being created or modified (be it directly using the settings-management.ts backend or the useBlueOsStorage composable), make sure it starts with `cockpit-` so its correctly tracked and parsed in our backend and UIs.
Loading