Updated contributing guide to require signed commits, added thumbs up/down feedback to mintlify
This commit is contained in:
parent
f02570cb6a
commit
4340b4b614
2 changed files with 49 additions and 4 deletions
|
|
@ -5,14 +5,56 @@ Thank you for your interest in contributing to the Model Context Protocol (MCP)
|
|||
## Getting Started
|
||||
|
||||
1. Install the required tools:
|
||||
- Node.js
|
||||
- Git
|
||||
- [Mintlify CLI](https://www.npmjs.com/package/mintlify): `npm i -g mintlify`
|
||||
|
||||
- Node.js
|
||||
- Git
|
||||
- [Mintlify CLI](https://www.npmjs.com/package/mintlify): `npm i -g mintlify`
|
||||
2. Fork and clone the repository
|
||||
3. Create a new branch for your changes
|
||||
4. Run `mintlify dev` to preview changes locally
|
||||
|
||||
## Signing Your Commits
|
||||
|
||||
We require all commits to be signed to verify the identity of contributors. Here's how to set up commit signing:
|
||||
|
||||
1. Generate a GPG key if you don't have one:
|
||||
|
||||
```bash
|
||||
gpg --full-generate-key
|
||||
```
|
||||
|
||||
- Choose RSA and RSA (default)
|
||||
- Choose 4096 bits
|
||||
- Enter your name and email (must match GitHub email)
|
||||
|
||||
2. Get your GPG key ID:
|
||||
|
||||
```bash
|
||||
gpg --list-secret-keys --keyid-format=long
|
||||
```
|
||||
|
||||
3. Configure Git to use your GPG key:
|
||||
|
||||
```bash
|
||||
git config --global user.signingkey YOUR_KEY_ID
|
||||
git config --global commit.gpgsign true
|
||||
```
|
||||
|
||||
4. Add your GPG key to GitHub:
|
||||
|
||||
- Copy your GPG key: `gpg --armor --export YOUR_KEY_ID`
|
||||
- Go to GitHub Settings > SSH and GPG keys
|
||||
- Click "New GPG key" and paste your key
|
||||
|
||||
5. For each commit, use:
|
||||
```bash
|
||||
git commit -S -m "Your commit message"
|
||||
```
|
||||
The `-S` flag signs your commit. With `commit.gpgsign` configured, you can omit the `-S` flag.
|
||||
|
||||
Note: On Windows, you might need to [download GPG4Win](https://www.gpg4win.org/) and configure its path in Git.
|
||||
|
||||
[You can learn more about signed commits here.](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)
|
||||
|
||||
## Documentation Guidelines
|
||||
|
||||
- Keep content clear, concise, and technically accurate
|
||||
|
|
|
|||
|
|
@ -64,5 +64,8 @@
|
|||
],
|
||||
"footerSocials": {
|
||||
"github": "https://github.com/modelcontextprotocol"
|
||||
},
|
||||
"feedback": {
|
||||
"thumbsRating": true
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue