Skip to content

app: AGENTS.md: docs: Add app/ development documentation and linting/formatting scripts#4365

Merged
k8s-ci-robot merged 4 commits intokubernetes-sigs:mainfrom
illume:app-agent
Jan 16, 2026
Merged

app: AGENTS.md: docs: Add app/ development documentation and linting/formatting scripts#4365
k8s-ci-robot merged 4 commits intokubernetes-sigs:mainfrom
illume:app-agent

Conversation

@illume
Copy link
Contributor

@illume illume commented Jan 16, 2026

Summary

Adds developer documentation and npm script wrappers for the desktop app to improve contributor experience and align with existing frontend/backend patterns.

Helps agents that get stuck when doing stuff in the app folder because they don't know how to lint/format/etc.

Changes

  • frontend: .eslintignore: .prettierignore: Ignore app .js files
  • package.json: app: Add format, lint and lint-fix scripts
  • docs/development/app.md: Add basic app developer guide
  • AGENTS.md: Add app/ folder development notes

Steps to Test

  1. Run npm run app:lint - should lint app TypeScript without errors
  2. Run npm run app:format - should format app TypeScript files
  3. Run npm run app:lint:fix - should fix auto-fixable issues
  4. Run root npm run lint - should include backend, frontend, and app
  5. Run git status after npm run app:build and it should not show any files.
  6. Run npm run app:lint after npm run app:build and it should not show any errors.

@k8s-ci-robot k8s-ci-robot requested review from skoeva and sniok January 16, 2026 16:14
@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jan 16, 2026
@illume illume requested a review from Copilot January 16, 2026 16:45
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds developer documentation and npm script wrappers for the desktop app to improve the contributor experience, particularly for AI agents working in the app folder. It provides consistent linting, formatting, and testing commands similar to frontend and backend workflows.

Changes:

  • Added npm script wrappers in root and app package.json for format, lint, and lint-fix operations
  • Updated ESLint and Prettier ignore files to exclude compiled JavaScript files from the app folder
  • Created comprehensive app development documentation at docs/development/app.md

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
package.json Added app:format, app:lint, and app:lint:fix scripts; integrated app linting into root lint commands
app/package.json Added format, lint, and lint-fix scripts that delegate to frontend scripts
frontend/.eslintignore Simplified to use wildcard pattern for app electron .js files
frontend/.prettierignore Added ignore pattern for compiled app JavaScript files
docs/development/app.md New comprehensive development guide covering build, lint, format, test, and packaging workflows
AGENTS.md Updated with app development documentation references and new example workflow

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Agents were getting lost when app/ folder changes were being made.
@joaquimrocha
Copy link
Contributor

/lgtm
/approve

Thanks @illume !

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 16, 2026
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: illume, joaquimrocha

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:
  • OWNERS [illume,joaquimrocha]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit 1d50613 into kubernetes-sigs:main Jan 16, 2026
12 checks passed
@illume illume deleted the app-agent branch January 16, 2026 19:03
@illume
Copy link
Contributor Author

illume commented Jan 16, 2026

Thanks for the review @joaquimrocha

@ashu8912 ashu8912 added this to the v0.40.0 milestone Feb 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. dx lfx lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants