-
Notifications
You must be signed in to change notification settings - Fork 142
Add AGENTS.md files to provide guidelines for project and packages
#2814
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: master
Are you sure you want to change the base?
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2814 +/- ##
=======================================
Coverage 71.85% 71.85%
=======================================
Files 134 134
Lines 7340 7340
Branches 1565 1620 +55
=======================================
Hits 5274 5274
Misses 1938 1938
Partials 128 128 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
yihao03
left a comment
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.
Great! just a few minor comments
| ## Development Workflow | ||
| * **Testing:** | ||
| * `npm test`: Runs unit and functional tests. | ||
| * `npm run updatetest`: Updates functional test snapshots. |
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.
should this go to the root AGENTS.md?
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.
good eye 👁️
| * `npm run dev` (in Root): Useful for watching changes. | ||
| * `npm run compile`: Manual TypeScript compilation. | ||
| * **Testing:** | ||
| * `npm run test`: Runs Jest tests. |
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.
shall we recommend running npm run setup to clean up and set up again, before testing?
| ## Development Workflow | ||
| * **Testing:** | ||
| * `npm test`: Run component tests. | ||
| * `npm run updatetest`: Snapshot updates. |
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.
same as above, put in the main AGENTS.md
What is the purpose of this pull request?
Overview of changes:
Add root
AGENT.mdin root of directory and root of each packageRelated to #2812
Anything you'd like to highlight/discuss:
Referred to some sources:
Testing instructions:
Proposed commit message: (wrap lines at 72 characters)
Add
AGENTS.mdfiles to root and package rootsChecklist: ☑️
Reviewer checklist:
Indicate the SEMVER impact of the PR:
At the end of the review, please label the PR with the appropriate label:
r.Major,r.Minor,r.Patch.Breaking change release note preparation (if applicable):