From 9fe50cf979760ed93905f99dff681a010f4b77c8 Mon Sep 17 00:00:00 2001
From: Takanori Hirano <me@hrntknr.net>
Date: Mon, 18 Aug 2025 11:55:33 +0000
Subject: [PATCH] docs: refactor contributing section and add AI development
 setup

- Move detailed contributing guidelines to CONTRIBUTING.md
- Add AI development environment setup instructions
- Update .gitignore to exclude AI assistant instruction files
- Simplify README contributing section with reference to CONTRIBUTING.md
---
 .gitignore      |  5 +++++
 CONTRIBUTING.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 README.md       | 46 +++++++++++++---------------------------------
 3 files changed, 61 insertions(+), 33 deletions(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/.gitignore b/.gitignore
index 84b1269..c8f8e97 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,10 @@
 data
 mcp-auth-proxy
+
+CLAUDE.md
+GEMINI.md
+.github/copilot-instructions.md
+
 # If you prefer the allow list template instead of the deny list, see community template:
 # https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
 #
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..50dd24c
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,43 @@
+# Contributing to MCP Auth Proxy
+
+Thank you for your interest in contributing to MCP Auth Proxy! This document provides guidelines and information for developers.
+
+## Commit Message Guidelines
+
+This project follows [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for commit messages. This helps with automated versioning, changelog generation, and makes the commit history more readable.
+
+### Types
+
+- **feat**: A new feature
+- **fix**: A bug fix
+- **docs**: Documentation only changes
+- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+- **refactor**: A code change that neither fixes a bug nor adds a feature
+- **perf**: A code change that improves performance
+- **test**: Adding missing tests or correcting existing tests
+- **build**: Changes that affect the build system or external dependencies
+- **ci**: Changes to our CI configuration files and scripts
+- **chore**: Other changes that don't modify src or test files
+- **revert**: Reverts a previous commit
+
+### Examples
+
+```
+feat: add GitHub OAuth provider support
+fix: resolve token expiration handling
+docs: update OAuth setup instructions
+refactor: simplify authentication middleware
+ci: add automated release workflow
+```
+
+### Breaking Changes
+
+Breaking changes should be indicated by a `!` after the type/scope:
+
+```
+feat!: change authentication API to support multiple providers
+```
+
+## Pull Request Template
+
+This project uses a pull request template to ensure consistency and completeness. Please follow the guidelines in [./.github/pull_request_template.md](./.github/pull_request_template.md) when creating pull requests.
diff --git a/README.md b/README.md
index d4bae40..f712f25 100644
--- a/README.md
+++ b/README.md
@@ -173,44 +173,24 @@ docker run --rm --net=host \
   http://localhost:8080
 ```
 
-## 👨‍💻 For Developers
+## 🤝 Contributing
 
-### Commit Message Guidelines
+For developer guidelines, contribution instructions, and commit message conventions, please see [CONTRIBUTING.md](./CONTRIBUTING.md).
 
-This project follows [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for commit messages. This helps with automated versioning, changelog generation, and makes the commit history more readable.
+### AI Development Environment Setup
 
-#### Types
+You can link CONTRIBUTING.md to your preferred AI development environment for better integration:
 
-- **feat**: A new feature
-- **fix**: A bug fix
-- **docs**: Documentation only changes
-- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
-- **refactor**: A code change that neither fixes a bug nor adds a feature
-- **perf**: A code change that improves performance
-- **test**: Adding missing tests or correcting existing tests
-- **build**: Changes that affect the build system or external dependencies
-- **ci**: Changes to our CI configuration files and scripts
-- **chore**: Other changes that don't modify src or test files
-- **revert**: Reverts a previous commit
-
-#### Examples
-
-```
-feat: add GitHub OAuth provider support
-fix: resolve token expiration handling
-docs: update OAuth setup instructions
-refactor: simplify authentication middleware
-ci: add automated release workflow
-```
-
-#### Breaking Changes
+```bash
+# For Claude Code
+ln -s CONTRIBUTING.md CLAUDE.md
 
-Breaking changes should be indicated by a `!` after the type/scope:
+# For Gemini
+ln -s CONTRIBUTING.md GEMINI.md
 
+# For GitHub Copilot
+mkdir -p .github
+ln -s CONTRIBUTING.md .github/copilot-instructions.md
 ```
-feat!: change authentication API to support multiple providers
-```
-
-### PR Template
 
-- [./.github/pull_request_template.md](./.github/pull_request_template.md)
+This allows your AI assistant to access the contribution guidelines regardless of which development environment you prefer to use.