docs: refactor contributing section and add AI development setup#29
docs: refactor contributing section and add AI development setup#29
Conversation
- 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
There was a problem hiding this comment.
Pull Request Overview
This PR improves documentation organization by extracting developer contribution guidelines from README.md into a dedicated CONTRIBUTING.md file and adds AI development environment setup instructions. This separation makes contribution guidelines more discoverable and provides standardized integration with AI coding assistants.
- Extracted commit message guidelines and PR template references into a dedicated CONTRIBUTING.md file
- Added AI development environment setup with symlink instructions for popular AI assistants
- Updated README.md to reference the new contributing document instead of inline guidelines
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Replaced inline contribution guidelines with reference to CONTRIBUTING.md and added AI development environment setup section |
| CONTRIBUTING.md | New file containing commit message conventions, examples, and PR template reference extracted from README.md |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
|
||
| # For GitHub Copilot | ||
| mkdir -p .github | ||
| ln -s CONTRIBUTING.md .github/copilot-instructions.md |
There was a problem hiding this comment.
The symlink command uses a relative path 'CONTRIBUTING.md' which will not work correctly when creating the symlink inside the .github directory. The command should use '../CONTRIBUTING.md' to properly reference the file from the .github subdirectory.
| ln -s CONTRIBUTING.md .github/copilot-instructions.md | |
| ln -s ../CONTRIBUTING.md .github/copilot-instructions.md |
Summary
This PR refactors the documentation structure by extracting contributing guidelines from README.md into a dedicated CONTRIBUTING.md file and adds AI development environment setup instructions. This improves organization and makes it easier for developers to find contribution guidelines.
Changes
CONTRIBUTING.mdwith commit message guidelines and PR template reference.gitignoreto exclude AI-specific instruction filesType of Change
Related Issues