-
Notifications
You must be signed in to change notification settings - Fork 63
Add AGENTS.md file #303
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
base: 1.x
Are you sure you want to change the base?
Add AGENTS.md file #303
Conversation
AGENTS.md
Outdated
| ## Code Style & Formatting | ||
|
|
||
| - **Use Laravel Pint** with the project's configuration (`pint.json`) | ||
| - **Strict typing**: Always use type hints for parameters and return types |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if we need this when it's also mentioned in the Type Safety section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated in b162b56
AGENTS.md
Outdated
| - Use `Location` helper for file/line detection | ||
| - Use `Clock` for timestamp management | ||
| - **Check property visibility**: Before using reflection, verify if Laravel properties are public. Prefer direct property access over reflection when possible. | ||
| - **Trust Laravel validation**: If Laravel validates a value, trust that validation rather than re-validating in our code |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure what kind of validations this refers to 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My agent wrote a lot of defensive code around the repeatSeconds property when I was testing it out on #302. I asked it to update it's context to prevent that when the value is coming from Laravel itself. It is a little misleading given that validation is a separate concept in Laravel.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated in 1adbdb5
This PR introduces a base set of agent guidelines for the project. The guidelines were agent-generated from our existing code, and then further refined until they were able to complete a basic task to an acceptable standard (See #302).