## Description
Add notes to various docs/bots that contributors are required to link
related issues in their PR descriptions, and that PRs without linked
issues may be closed. This is to ensure that all contributions are tied
to an existing issue and to improve the traceability of changes.
## Related Issue(s)
<!-- Link to the issue(s) this PR addresses, using hashtag notation:
Fixes#123 -->
## Type of Change
- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [ ] Documentation update
- [ ] Code refactoring
- [ ] Performance improvement
- [ ] Test update
## Checklist
- [ ] I have made corresponding changes to the documentation (if
applicable)
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have addressed all Coderabbit comments on this PR
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## ELI5
This PR updates the project's documentation and templates to make it a
requirement that developers link the related issues when they submit
pull requests. It's like saying "when you fix something, tell us which
problem you're solving" so everyone can track why changes were made.
---
## Changes Made
### Pull Request Template (`.github/PULL_REQUEST_TEMPLATE.md`)
- Added a required "Related issue(s)" section in the PR template
- Added required prompts to link issues using `Fixes #...` or `Closes
#...` syntax
- Updated the PR checklist to include a checkbox requiring that related
issues be linked in the description
### Contribution Guidelines (`CONTRIBUTING.md`)
- Strengthened PR requirements by making issue linking mandatory
- Added explicit requirement that PR descriptions must include links to
related issues using `Fixes #...` / `Closes #...` style
- Added requirement that PRs clearly describe both the problem being
solved and the solution provided
### Development Guide (`DEVELOPMENT.md`)
- Expanded the "Contributing" section's pull request instructions to
include expectations for linking related issues
- Added a note that PRs without linked issues may be closed to ensure
contributions are properly tracked
### External Contributor Triage Workflow
(`.github/workflows/pr-triage.yml`)
- Updated the automated bot comment for external contributors to
explicitly require linking an issue (e.g., `Fixes #1234`/`Closes #1234`)
- Retained existing CodeRabbit feedback-handling guidance while removing
previous review trigger instructions
### Feature Request Template
(`.github/ISSUE_TEMPLATE/feature_request.yml`)
- Updated the selectable "Component" options to reflect current project
structure
- Replaced previous options with: Studio, Memory, Workspaces,
Observability, Deployment, CLI, Server, and Other
[](https://app.coderabbit.ai/change-stack/mastra-ai/mastra/pull/16397)
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
## Description
- Add docs styleguides
- Add AGENTS.md files and point CLAUDE.md file to it
- Add mastra-docs claude skill
- Improve prompts on writing docs
## Related Issue(s)
Fixes DEVED-110
## Type of Change
- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [X] Documentation update
- [ ] Code refactoring
- [ ] Performance improvement
- [ ] Test update
## Checklist
- [ ] I have made corresponding changes to the documentation (if
applicable)
- [ ] I have added tests that prove my fix is effective or that my
feature works
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Added comprehensive docs and styleguides (DOC, STYLEGUIDE, GUIDE_* ,
REFERENCE) and new AGENTS.md; reorganized docs content and contributor
workflow.
* Replaced extensive CLAUDE.md content with pointer to AGENTS.md;
cleared docs changelog and removed some legacy guideline files.
* Updated CLI/pr/changeset prompts and guidance to require multiple
changesets for multi-package changes and warn against very long
changesets.
* **Community**
* Updated Code of Conduct with expanded scope and clearer enforcement
guidance.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
New contributors may run `pnpm test:combined-stores` and face failures
or confusion because Cloudflare creds are needed for
`stores/vectorize/index.test.ts`, but this wasn't documented.
This PR adds:
- `CLOUDFLARE_ACCOUNT_ID`
- `CLOUDFLARE_API_TOKEN`
to avoid onboarding friction and make test setup clearer for new
contributors.
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Expanded development setup guidance with additional environment
variable configuration examples required for complete platform
integration setup.
<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
## Description
`pnpm setup` is this https://pnpm.io/cli/setup, not `pnpm run setup`.
## Related Issue(s)
## Type of Change
- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [ ] Documentation update
- [ ] Code refactoring
- [ ] Performance improvement
- [ ] Test update
## Checklist
- [ ] I have made corresponding changes to the documentation (if
applicable)
- [ ] I have added tests that prove my fix is effective or that my
feature works
## Description
<!-- Provide a brief description of the changes in this PR -->
`pnpm build` sometimes fails so added instructions to `DEVELOPEMENT.md`
to increase the heap memory for `NODE`
`pnpm setup` conflicts with `pnpm` builtin `setup` command so updated
instruction to `pnpm run setup`
## Related Issue(s)
<!-- Link to the issue(s) this PR addresses, using hashtag notation:
#123 -->
## Type of Change
- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [x] Documentation update
- [ ] Code refactoring
- [ ] Performance improvement
- [ ] Test update
## Checklist
- [ ] I have made corresponding changes to the documentation (if
applicable)
- [ ] I have added tests that prove my fix is effective or that my
feature works
## Description
Update DEVELOPMENT.md to include combined stores tests command
## Related Issue(s)
<!-- Link to the issue(s) this PR addresses, using hashtag notation:
#123 -->
## Type of Change
- [x] Documentation update
## Checklist
- [x] I have performed a self-review of my own code
- [x] I have made corresponding changes to the documentation (if
applicable)
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] I have generated a changeset for this PR