Skip to content

Commit 4340b4b

Browse files
committed
Updated contributing guide to require signed commits, added thumbs up/down feedback to mintlify
1 parent f02570c commit 4340b4b

File tree

2 files changed

+49
-4
lines changed

2 files changed

+49
-4
lines changed

CONTRIBUTING.md

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,56 @@ Thank you for your interest in contributing to the Model Context Protocol (MCP)
55
## Getting Started
66

77
1. Install the required tools:
8-
- Node.js
9-
- Git
10-
- [Mintlify CLI](https://www.npmjs.com/package/mintlify): `npm i -g mintlify`
11-
8+
- Node.js
9+
- Git
10+
- [Mintlify CLI](https://www.npmjs.com/package/mintlify): `npm i -g mintlify`
1211
2. Fork and clone the repository
1312
3. Create a new branch for your changes
1413
4. Run `mintlify dev` to preview changes locally
1514

15+
## Signing Your Commits
16+
17+
We require all commits to be signed to verify the identity of contributors. Here's how to set up commit signing:
18+
19+
1. Generate a GPG key if you don't have one:
20+
21+
```bash
22+
gpg --full-generate-key
23+
```
24+
25+
- Choose RSA and RSA (default)
26+
- Choose 4096 bits
27+
- Enter your name and email (must match GitHub email)
28+
29+
2. Get your GPG key ID:
30+
31+
```bash
32+
gpg --list-secret-keys --keyid-format=long
33+
```
34+
35+
3. Configure Git to use your GPG key:
36+
37+
```bash
38+
git config --global user.signingkey YOUR_KEY_ID
39+
git config --global commit.gpgsign true
40+
```
41+
42+
4. Add your GPG key to GitHub:
43+
44+
- Copy your GPG key: `gpg --armor --export YOUR_KEY_ID`
45+
- Go to GitHub Settings > SSH and GPG keys
46+
- Click "New GPG key" and paste your key
47+
48+
5. For each commit, use:
49+
```bash
50+
git commit -S -m "Your commit message"
51+
```
52+
The `-S` flag signs your commit. With `commit.gpgsign` configured, you can omit the `-S` flag.
53+
54+
Note: On Windows, you might need to [download GPG4Win](https://www.gpg4win.org/) and configure its path in Git.
55+
56+
[You can learn more about signed commits here.](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)
57+
1658
## Documentation Guidelines
1759

1860
- Keep content clear, concise, and technically accurate

mint.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,5 +64,8 @@
6464
],
6565
"footerSocials": {
6666
"github": "https://github.com/modelcontextprotocol"
67+
},
68+
"feedback": {
69+
"thumbsRating": true
6770
}
6871
}

0 commit comments

Comments
 (0)