Skip to content

Commit 6253f5a

Browse files
authored
Update AGENTS.md
1 parent 79e1962 commit 6253f5a

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

AGENTS.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,23 @@ yarn test
5757
```bash
5858
yarn release:changelog
5959
```
60-
Copy the output to the top of `CHANGELOG.md` with the current date. Update the "High level enhancements" section and clean up the history for public release.
60+
Copy the output to the top of `CHANGELOG.md` with the current date. Update the "High level enhancements" section (high-level summary of new features or bug fixes) and clean up the history for public release.
6161
3. **Cleanup documentation** in `README.md`, `packages/docusaurus-plugin-openapi-docs/README.md` and `demo/docs/intro.mdx`.
6262
4. **Commit** all changes with the message `Prepare release vX.Y.Z`.
6363

6464
Once merged, the `release.yaml` workflow will publish the release automatically.
65+
66+
## Handling Issues and Pull Requests
67+
68+
### Issues
69+
70+
- Triage each report to figure out whether it's a question, documentation request, or bug.
71+
- Investigate carefully to confirm the problem is within this project and not caused by user error, dependency mismatches, or other external factors.
72+
- Consider how a fix might affect existing features and avoid any regression or breaking change.
73+
74+
### Pull Requests
75+
76+
- Start by checking if the contribution updates documentation, fixes a bug, or adds or enhances a feature.
77+
- Ensure the proposal fits the scope of the project and doesn't duplicate existing docs or functionality.
78+
- Provide a summary of whether the pull request is ready to merge or what changes are still needed from the contributor.
79+
- Consider how merging the pull request might affect existing features and make sure it does not introduce regressions or breaking changes.

0 commit comments

Comments
 (0)