@@ -5,26 +5,19 @@ This document provides guidance for developers contributing to this project and
55## Setting Up Development Environment
66
771 . Clone the repository:
8-
98 ``` bash
109 git clone https://github.com/zandko/mcp-use.git
1110 cd mcp-use
1211 ```
13-
14122 . Install dependencies:
15-
1613 ``` bash
1714 pnpm install
1815 ```
19-
2016 > ** Note** : This project requires Node.js version 22 or higher.
21-
22173 . Build the project:
23-
2418 ``` bash
2519 pnpm build
2620 ```
27-
28214 . Watch for changes during development:
2922 ``` bash
3023 pnpm watch
@@ -62,37 +55,26 @@ We use GitHub Actions to automate our release process, connecting GitHub Release
6255#### For Maintainers
6356
64571 . ** Prepare for Release** :
65-
6658 Update the version in ` package.json ` using one of these commands:
67-
6859 ``` bash
6960 # For patch releases (0.0.x) - Bug fixes
7061 pnpm run release
71-
7262 # For minor releases (0.x.0) - New features
7363 pnpm run release:minor
74-
7564 # For major releases (x.0.0) - Breaking changes
7665 pnpm run release:major
7766 ```
78-
7967 This will:
80-
8168 - Update the version in package.json
8269 - Create a git tag
8370 - Push the changes and tag to GitHub
84-
85712 . ** Create GitHub Release** :
86-
8772 - Go to GitHub repository → "Releases" → "Draft a new release"
8873 - Choose the tag that was just created
8974 - Fill in release notes detailing what's new, fixes, and any breaking changes
9075 - Click "Publish release"
91-
92763 . ** Automated Publishing** :
93-
9477 The GitHub Action will automatically:
95-
9678 - Verify the package version matches the GitHub tag
9779 - Run linting and build checks
9880 - Generate a changelog from commits since the last release
@@ -106,15 +88,11 @@ We use GitHub Actions to automate our release process, connecting GitHub Release
10688To set up automated publishing:
10789
108901 . Generate an NPM access token:
109-
11091 - Go to npmjs.com → User Settings → Access Tokens
11192 - Create a new token with "Automation" type and publish permissions
112-
113932 . Add the token to GitHub repository secrets:
114-
11594 - Go to your GitHub repository → Settings → Secrets → Actions
11695 - Add a new secret named ` NPM_TOKEN ` with the value of your NPM token
117-
118963 . (Optional) Discord notifications:
11997 - Create a Discord webhook in your server
12098 - Add the webhook URL as a GitHub repository secret named ` DISCORD_WEBHOOK `
0 commit comments