From 4340b4b614b5d87634d01b1b8c5554db65550a19 Mon Sep 17 00:00:00 2001 From: Zachary Lee Date: Tue, 26 Nov 2024 14:11:12 -0500 Subject: [PATCH] Updated contributing guide to require signed commits, added thumbs up/down feedback to mintlify --- CONTRIBUTING.md | 50 +++++++++++++++++++++++++++++++++++++++++++++---- mint.json | 3 +++ 2 files changed, 49 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 68d0b96..63cc1d9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/mint.json b/mint.json index 1f47020..6e20058 100644 --- a/mint.json +++ b/mint.json @@ -64,5 +64,8 @@ ], "footerSocials": { "github": "https://github.com/modelcontextprotocol" + }, + "feedback": { + "thumbsRating": true } }