0
Fork 0
mirror of https://github.com/mastra-ai/mastra.git synced 2026-11-17 08:44:46 +00:00
Commit graph

22 commits

Author SHA1 Message Date
Lennart
6f5a36d8f9
chore(repo): Mention new PR policy (#27829) 2026-10-20 08:38:31 -07:00
devin-ai-integration[bot]
41da786907
chore: align contributor Node.js requirement with tsdown (#25918)
Co-authored-by: lennart <lennart@mastra.ai>
2026-10-05 10:17:56 +02:00
Neil Daquioag
b2bb3f6665
docs: fix onboarding quickstart, pnpm version, and template metadata (#23754)
Co-authored-by: Lennart <lekoarts@gmail.com>
2026-09-15 09:40:58 +02:00
Lennart
85fac7b637
docs: add Factory cross-links and refresh contributor guidance (#23509) 2026-09-10 07:45:21 -07:00
Lennart
594b5d508a
chore(repo): Note requirement of linked issue (#16397)
## 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

[![Review Change
Stack](https://storage.googleapis.com/coderabbit_public_assets/review-stack-in-coderabbit-ui.svg)](https://app.coderabbit.ai/change-stack/mastra-ai/mastra/pull/16397)

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-05-10 21:20:54 -04:00
Akash Santra
eac259a920
fix(docs): unify CLI command and fix grammar across docs (#15854) 2026-04-28 08:35:15 -07:00
Lennart
13457109af
chore(repo): Callout coderabbit in PR reviews (#13776) 2026-03-04 16:31:18 +01:00
Lennart
b6fd5edf56
chore: Add docs styleguides (#13263)
## 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>
2026-02-19 13:45:33 +01:00
Anurag Ojha
fb50c4e20a
docs: Add "Testing Local Changes" section to Development Guide (#11778) 2026-01-13 11:07:01 +01:00
Anurag Ojha
481bb1133a
docs/add-cloudflare-env (#10724)
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 -->
2025-12-01 18:33:58 -06:00
Lennart
75136488da
chore: Improve internal docs and bug report template (#10159)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2025-11-17 13:59:22 +01:00
Alexandre de Boutray
785251b90f
Fix dev setup instructions (#6445)
## 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
2025-08-04 15:05:50 -07:00
Tyler Barnes
5f90ab9acd
chore: prettier format (#5567) 2025-06-30 13:09:47 -07:00
abab-dev
8d03022b3a
fix : Few minor changes to developement.md for local setup (#4536)
## 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
2025-05-30 12:17:35 +02:00
Raúl Anatol
f480d07ebd
docs: update DEVELOPMENT.md to include combined stores tests (#3818)
## 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
2025-04-25 10:07:25 -07:00
Abhi Aiyer
8bb94781d1 Update development.md 2025-03-31 00:40:49 -07:00
Ward Peeters
eb80124dea docs: use corepack 2025-01-06 15:11:52 +01:00
Joshua Folorunsho
8ae480f45a add step to generate schema 2024-12-20 11:56:51 +01:00
Joshua Folorunsho
5c93bbe7e1 add step to generate a new integration 2024-12-20 11:10:04 +01:00
Shane Thomas
b0ce8f6525 Fix so prepare will work during cli tests and local dev install 2024-12-12 16:24:58 -06:00
Abhi Aiyer
49b76bfacb fix ci 2024-12-05 23:49:24 -08:00
Joshua Folorunsho
2ddc8c4450 update readme, and create development for setting up your db environment 2024-11-28 14:12:59 +01:00