mirror of
https://github.com/harvester/harvester-ui-extension.git
synced 2026-10-06 14:16:05 +08:00
docs: add AGENTS.md for AI agent guidance (#837)
* feat: add AGENNTS.md Signed-off-by: Andy Lee <andy.lee@suse.com> * refactor: update based on copilot feedback Signed-off-by: Andy Lee <andy.lee@suse.com> * refactor: update AGENTS.md Signed-off-by: Andy Lee <andy.lee@suse.com> * refactor: update based on AI suggestion Signed-off-by: Andy Lee <andy.lee@suse.com> * refactor: based on comments Signed-off-by: Andy Lee <andy.lee@suse.com> * refactor: some files Signed-off-by: Andy Lee <andy.lee@suse.com> * refactor: boundaries.md Signed-off-by: Andy Lee <andy.lee@suse.com> --------- Signed-off-by: Andy Lee <andy.lee@suse.com>
This commit is contained in:
@@ -0,0 +1,23 @@
|
||||
## Boundaries
|
||||
|
||||
- ✅ **Always:**
|
||||
- Write to `.github`, `docs/`, `pkg/harvester`, `scripts/`.
|
||||
- Make commits in a new branch (for a PR).
|
||||
- Run `yarn lint:fix` before commits.
|
||||
- Use conventional commit format:
|
||||
```
|
||||
<type>:
|
||||
|
||||
<description>
|
||||
```
|
||||
- Follow existing naming conventions (PascalCase for components, camelCase for functions).
|
||||
- After changing a Vue, JS, or TS file, make sure it's automatically formatted with ESLint.
|
||||
- After updating files in `docs/agents.md/`, run `yarn agents:generate` to update root `AGENTS.md`.
|
||||
- ⚠️ **Ask first:**
|
||||
- Adding dependencies
|
||||
- Upgrading dependencies
|
||||
- 🚫 **Never:**
|
||||
- Commit or log secrets, `.env`, `kubeconfig` or any API keys.
|
||||
- Edit `node_modules/`.
|
||||
- Commit directly to `main` (use PRs).
|
||||
- Skip git hooks with `--no-verify` flag.
|
||||
Reference in New Issue
Block a user