Skip to content

Commit be0ea78

Browse files
authored
Add CONTRIBUTING.md (#15)
1 parent 9cfa555 commit be0ea78

2 files changed

Lines changed: 28 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contributing
2+
3+
## Adding Changes
4+
5+
1. Make your changes in a PR
6+
2. If your change affects users (features, fixes, breaking changes), add a changeset:
7+
```bash
8+
npx changeset
9+
```
10+
3. Commit the generated `.changeset/*.md` file with your PR
11+
12+
Skip the changeset for internal changes (CI, tests, docs, refactors with no API impact).
13+
14+
## Releasing
15+
16+
When changesets are merged to `main`, a "Version Packages" PR is automatically created/updated.
17+
18+
Merging that PR:
19+
- Bumps the version in `package.json`
20+
- Updates `CHANGELOG.md`
21+
- Publishes to npm
22+
- Creates a GitHub Release
23+
24+
You control when to release by choosing when to merge the "Version Packages" PR. Multiple changesets can accumulate before releasing.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -445,6 +445,10 @@ This writes a `.env.local` file with all the required environment variables (AI_
445445

446446
**Test incrementally**: Start with simple tasks, add complexity as you learn what works.
447447

448+
## Contributing
449+
450+
See [CONTRIBUTING.md](CONTRIBUTING.md) for development workflow and release process.
451+
448452
## License
449453

450454
MIT

0 commit comments

Comments
 (0)