Skip to content

Commit ec098ff

Browse files
committed
fix: docs
1 parent 7848d23 commit ec098ff

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

CONTRIBUTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,40 @@ When adding new tools to the MCP server:
141141
4. Add proper documentation for the tool
142142
5. Include examples of how to use the tool
143143

144+
## Release Process
145+
146+
Our release process is automated using GitHub Actions workflows:
147+
148+
### Version Bumping
149+
150+
1. To create a new version, go to the GitHub repository Actions tab
151+
2. Select the "Version Bump" workflow
152+
3. Click "Run workflow" and choose one of the following options:
153+
- `patch` (e.g., 1.0.0 → 1.0.1) for backward-compatible bug fixes
154+
- `minor` (e.g., 1.0.0 → 1.1.0) for backward-compatible new features
155+
- `major` (e.g., 1.0.0 → 2.0.0) for breaking changes
156+
- A specific version number (e.g., `1.2.3`)
157+
4. This creates a pull request with the version change
158+
5. Once approved and merged, the version is updated
159+
160+
### Automatic Publishing
161+
162+
When a version bump is merged to the main branch:
163+
164+
1. The "Publish" workflow automatically runs
165+
2. It checks if the version already exists as a git tag
166+
3. If the version is new, it:
167+
- Builds the package
168+
- Publishes to NPM
169+
- Creates a git tag for the version
170+
- Creates a GitHub release with auto-generated release notes
171+
172+
### Code Quality
173+
174+
All pull requests automatically run through the "Code Health" workflow, which:
175+
- Verifies code style and formatting
176+
- Runs tests on multiple platforms (Ubuntu, macOS, Windows)
177+
144178
## License
145179

146180
By contributing to this project, you agree that your contributions will be licensed under the project's license.

0 commit comments

Comments
 (0)