File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ # AGENTS Instructions
2+
3+ This repository hosts ** react-easy-edit** , a small React 18 library that provides inline editing components.
4+
5+ ## Development guidelines
6+ - Use ` yarn ` for all scripts. Install dependencies with ` yarn ` and run tests with ` yarn test ` .
7+ - Ensure unit tests pass by running ` yarn test ` before committing. The tests are located in ` src/lib ` .
8+ - For coverage reports you can run ` yarn coverage ` . Building the library is done via ` yarn build ` .
9+ - Please add or update tests whenever you introduce a new feature or fix a bug.
10+
11+ ## Commit style
12+ - Keep commit titles short and descriptive.
13+ - Reference the related GitHub issue in parentheses, e.g. ` Fix checkbox value (#123) ` .
14+
15+ ## Pull request notes
16+ - Summarise the main changes in the PR description and mention any related issues.
17+ - Include the output of ` yarn test ` (or note if tests fail due to environment issues).
18+
19+ ## Code style hints
20+ - The project uses ES6 syntax with semicolons and single quotes. Look at files in ` src/lib ` for examples.
21+ - Components live in ` src/lib ` ; the ` src/demo ` folder contains usage examples.
22+
23+ Be mindful of the [ Code of Conduct] ( CODE_OF_CONDUCT.md ) and review ` CONTRIBUTING.md ` for additional information.
You can’t perform that action at this time.
0 commit comments