-
Notifications
You must be signed in to change notification settings - Fork 14
build(agents): add AGENTS.md #1527
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.
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
spike-rabbit
wants to merge
1
commit into
main
Choose a base branch
from
build/agents-md
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| You are an expert in TypeScript, Angular, and scalable web application development. You write maintainable, performant, and accessible code following Angular and TypeScript best practices. | ||
|
|
||
| ## TypeScript Best Practices | ||
|
|
||
| - Use strict type checking | ||
| - Prefer type inference when the type is obvious | ||
| - Avoid the `any` type; use `unknown` when type is uncertain | ||
|
|
||
| ## Angular Best Practices | ||
|
|
||
| - Always use standalone components over NgModules | ||
| - Must NOT set `standalone: true` inside Angular decorators. It's the default. | ||
| - Use signals for state management | ||
| - Implement lazy loading for feature routes | ||
| - Do NOT use the `@HostBinding` and `@HostListener` decorators. Put host bindings inside the `host` object of the `@Component` or `@Directive` decorator instead | ||
|
|
||
| ## Components | ||
|
|
||
| - Keep components small and focused on a single responsibility | ||
| - Use `input()` and `output()` functions instead of decorators | ||
| - Use `computed()` for derived state | ||
| - Set `changeDetection: ChangeDetectionStrategy.OnPush` in `@Component` decorator | ||
| - Prefer inline templates for small components | ||
| - Prefer Reactive forms instead of Template-driven ones | ||
| - Do NOT use `ngClass`, use `class` bindings instead | ||
| - Do NOT use `ngStyle`, use `style` bindings instead | ||
|
|
||
| ## State Management | ||
|
|
||
| - Use signals for local component state | ||
| - Use `computed()` for derived state | ||
| - Keep state transformations pure and predictable | ||
| - Do NOT use `mutate` on signals, use `update` or `set` instead | ||
|
|
||
| ## Templates | ||
|
|
||
| - Keep templates simple and avoid complex logic | ||
| - Use native control flow (`@if`, `@for`, `@switch`) instead of `*ngIf`, `*ngFor`, `*ngSwitch` | ||
| - Use the async pipe to handle observables | ||
|
|
||
| ## Services | ||
|
|
||
| - Design services around a single responsibility | ||
| - Use the `providedIn: 'root'` option for singleton services | ||
| - Use the `inject()` function instead of constructor injection | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.