Skip to content
This repository was archived by the owner on Jan 29, 2026. It is now read-only.

Commit 0daa18b

Browse files
Chris Dukesclaude
authored and
Chris Dukes
committed
docs: add comprehensive CONTRIBUTING.md with commit message guidelines
This commit addresses the need for better commit documentation by adding a comprehensive contributing guide that includes: - Detailed commit message format and conventions - Examples of good vs. poor commit messages (using the recent "1.0.5" as example) - Development workflow guidelines - Testing requirements before PR submission - AI-assisted development best practices - Issue reporting and feature request guidelines - Code of conduct principles The guide specifically addresses the sparse commit message issue identified in commit 17a66e3 by providing clear examples of how version bump commits should be documented with context about what's included in the release. This will help future contributors maintain consistent, informative commit history that benefits the entire development community. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 1084938 commit 0daa18b

File tree

1 file changed

+144
-0
lines changed

1 file changed

+144
-0
lines changed

‎CONTRIBUTING.md‎

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
# 🤝 Contributing to Gemini-Flow
2+
3+
Thank you for your interest in contributing to Gemini-Flow! This document provides guidelines and best practices for contributing to our revolutionary multi-model AI orchestration platform.
4+
5+
## 📝 Commit Message Guidelines
6+
7+
Clear and descriptive commit messages are crucial for maintaining a readable project history. Please follow these conventions:
8+
9+
### Commit Message Format
10+
11+
```
12+
<type>: <subject>
13+
14+
<body>
15+
16+
<footer>
17+
```
18+
19+
### Types
20+
21+
- **feat**: New feature
22+
- **fix**: Bug fix
23+
- **docs**: Documentation changes
24+
- **style**: Code style changes (formatting, missing semicolons, etc.)
25+
- **refactor**: Code refactoring
26+
- **test**: Adding or updating tests
27+
- **chore**: Maintenance tasks (updating dependencies, version bumps, etc.)
28+
- **perf**: Performance improvements
29+
30+
### Examples
31+
32+
#### ❌ Poor Commit Message
33+
```
34+
1.0.5
35+
```
36+
37+
#### ✅ Good Commit Message
38+
```
39+
chore: bump version to 1.0.5
40+
41+
- Updated package.json version from 1.0.4 to 1.0.5
42+
- Synchronized package-lock.json
43+
- Release includes:
44+
* New copilot-instructions.md with MCP integrations
45+
* Bug fixes and project cleanup
46+
* README.md corrections
47+
48+
🤖 Generated with [Claude Code](https://claude.ai/code)
49+
50+
Co-Authored-By: Claude <noreply@anthropic.com>
51+
```
52+
53+
### Best Practices
54+
55+
1. **Be Descriptive**: Explain what changed and why
56+
2. **Reference Issues**: Include issue numbers when applicable (e.g., `fixes #123`)
57+
3. **List Changes**: For version bumps, list what's included in the release
58+
4. **Use Present Tense**: "Add feature" not "Added feature"
59+
5. **Keep Lines Short**:
60+
- Subject line: 50 characters max
61+
- Body lines: 72 characters max
62+
63+
## 🚀 Development Workflow
64+
65+
1. **Fork the repository**
66+
2. **Create a feature branch**: `git checkout -b feature/amazing-feature`
67+
3. **Make your changes**
68+
4. **Write/update tests** as needed
69+
5. **Ensure all tests pass**: `npm test`
70+
6. **Commit with descriptive message** (see guidelines above)
71+
7. **Push to your fork**: `git push origin feature/amazing-feature`
72+
8. **Create a Pull Request**
73+
74+
## 🧪 Testing
75+
76+
Before submitting a PR:
77+
78+
```bash
79+
# Run all tests
80+
npm test
81+
82+
# Run linting
83+
npm run lint
84+
85+
# Run type checking
86+
npm run typecheck
87+
88+
# Build the project
89+
npm run build
90+
```
91+
92+
## 🤖 AI-Assisted Development
93+
94+
When using AI tools (like Claude Code or GitHub Copilot) for contributions:
95+
96+
1. **Review Generated Code**: Always review AI-generated code for correctness
97+
2. **Test Thoroughly**: AI code needs the same testing standards
98+
3. **Credit AI Assistance**: Add co-authorship in commits when appropriate:
99+
```
100+
Co-Authored-By: Claude <noreply@anthropic.com>
101+
```
102+
103+
## 📚 Documentation
104+
105+
- Update documentation for any new features
106+
- Include JSDoc comments for new functions
107+
- Update README.md if adding major features
108+
- Add examples for complex functionality
109+
110+
## 🐛 Reporting Issues
111+
112+
When reporting issues:
113+
114+
1. **Search existing issues** first
115+
2. **Use issue templates** when available
116+
3. **Provide reproduction steps**
117+
4. **Include environment details**:
118+
- Node.js version
119+
- Operating system
120+
- Gemini-Flow version
121+
122+
## 💡 Feature Requests
123+
124+
We welcome feature requests! Please:
125+
126+
1. **Check existing requests** first
127+
2. **Describe the use case** clearly
128+
3. **Explain the benefit** to the project
129+
4. **Consider implementation** complexity
130+
131+
## 🏛️ Code of Conduct
132+
133+
- Be respectful and inclusive
134+
- Welcome newcomers and help them get started
135+
- Focus on constructive criticism
136+
- Celebrate diverse perspectives
137+
138+
## 📜 License
139+
140+
By contributing to Gemini-Flow, you agree that your contributions will be licensed under the MIT License.
141+
142+
---
143+
144+
Thank you for helping make Gemini-Flow better! Every contribution, no matter how small, helps advance the quantum revolution in AI orchestration. 🚀

0 commit comments

Comments
 (0)