Skip to content

Commit bc95fde

Browse files
GeneAIclaude
andcommitted
docs: Add GOVERNANCE.md for project governance structure
Created comprehensive governance document for OpenSSF Best Practices Badge requirement and community transparency. **Document Scope**: - **Project Structure**: Single maintainer model with evolution path - **Roles**: Maintainer, Contributors, Users with clear responsibilities - **Decision Process**: Standard vs. major changes, security handling - **Release Process**: SemVer, cadence, comprehensive checklist - **Code of Conduct**: Principles, expected behavior, enforcement - **Communication**: GitHub-centric with future expansion plans **Key Sections**: 1. **Decision-Making Structure**: - Current: Single maintainer (Patrick Roebuck, Deep Study AI) - Future: Path to core contributors, steering committee - Clear authority boundaries 2. **Roles and Responsibilities**: - Maintainer: Final approval, releases, security, roadmap - Contributors: Anyone can submit PRs, report bugs, suggest features - Users: Use under Fair Source 0.9, provide feedback 3. **Decision-Making Process**: - Standard changes: 1-7 day review cycle - Major changes: RFC with 7-day community input - Security: Private reporting, 48-hour response, coordinated disclosure 4. **Release Process**: - Semantic Versioning (currently 1.6.1) - 9-step checklist including 1,247+ tests, 83%+ coverage - Regular cadence: patches as needed, minors every 4-8 weeks 5. **Code of Conduct**: - Values: Respectful, constructive, inclusive, professional - Clear expected/unacceptable behavior guidelines - Maintainer enforcement authority 6. **Roadmap and Planning**: - Current: 90% coverage push, OpenSSF badge - Near-term: v2.0.0 release, Claude Code partnership - Long-term: Silver/Gold badges, enterprise adoption **OpenSSF Requirement**: This document satisfies the OpenSSF Best Practices Badge requirement for documented project governance and decision-making process. **License Information**: - Code: Fair Source 0.9 (free for individuals/small teams) - Docs: CC BY 4.0 - CLA: Implicit in contributions **Living Document**: Will be reviewed every 6 months or when contributor base grows beyond 10 active contributors. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 08d7bbb commit bc95fde

File tree

1 file changed

+269
-0
lines changed

1 file changed

+269
-0
lines changed

GOVERNANCE.md

Lines changed: 269 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,269 @@
1+
# Governance
2+
3+
This document outlines the governance structure for the Empathy Framework project.
4+
5+
## Project Overview
6+
7+
The **Empathy Framework** is an open-source project providing a five-level maturity model for AI-human collaboration, progressing from reactive responses to anticipatory problem prevention.
8+
9+
- **License**: Fair Source 0.9 (dual licensing: free for individuals/education/small teams, commercial for larger organizations)
10+
- **Organization**: Deep Study AI, LLC
11+
- **Repository**: https://github.com/Smart-AI-Memory/empathy
12+
- **Documentation**: https://github.com/Smart-AI-Memory/empathy/tree/main/docs
13+
14+
## Decision-Making Structure
15+
16+
### Single Maintainer Model
17+
18+
The Empathy Framework currently operates under a **single maintainer model** for rapid development and clear decision-making authority:
19+
20+
- **Maintainer**: Patrick Roebuck (Deep Study AI, LLC)
21+
22+
- GitHub: @silversurfer562
23+
- Role: Final decision authority, release management, security response
24+
25+
### Future Governance Evolution
26+
27+
As the project grows and attracts more contributors, the governance model may evolve to include:
28+
- **Core Contributors**: Regular contributors with merge privileges
29+
- **Technical Steering Committee**: For major architectural decisions
30+
- **Community Maintainers**: Domain-specific package maintainers
31+
32+
## Roles and Responsibilities
33+
34+
### Maintainer
35+
36+
**Responsibilities**:
37+
- Final approval on all pull requests
38+
- Release planning and execution
39+
- Security vulnerability response
40+
- Roadmap planning and prioritization
41+
- Community management
42+
- License compliance
43+
- OpenSSF Best Practices Badge maintenance
44+
45+
**Authority**:
46+
- Merge privileges on main branch
47+
- PyPI package publishing
48+
- Security disclosure coordination
49+
- Breaking change decisions
50+
51+
### Contributors
52+
53+
**Anyone can contribute** by:
54+
- Submitting pull requests
55+
- Reporting bugs and issues
56+
- Suggesting features
57+
- Improving documentation
58+
- Participating in discussions
59+
60+
**Contributor Rights**:
61+
- Credit in commit history
62+
- Recognition in release notes
63+
- Co-Authored-By tags for significant contributions
64+
65+
### Users
66+
67+
**Users** can:
68+
- Use the framework under Fair Source 0.9 license terms
69+
- Report issues and bugs
70+
- Request features
71+
- Participate in community discussions
72+
- Provide feedback on documentation
73+
74+
## Decision-Making Process
75+
76+
### Standard Changes
77+
78+
**Process**:
79+
1. Issue or pull request submitted
80+
2. Discussion and review
81+
3. Maintainer approval/rejection
82+
4. Merge to main branch
83+
84+
**Timeline**: Typically 1-7 days depending on complexity
85+
86+
### Major Changes
87+
88+
**Criteria for "major"**:
89+
- Breaking API changes
90+
- New core abstractions
91+
- License changes
92+
- Architectural shifts
93+
- New external dependencies
94+
95+
**Process**:
96+
1. RFC (Request for Comments) issue created
97+
2. Community discussion period (minimum 7 days)
98+
3. Maintainer decision with rationale
99+
4. Implementation and migration guide
100+
101+
### Security Issues
102+
103+
**Process**:
104+
- Reported privately to [email protected]
105+
- Maintainer acknowledgment within 48 hours
106+
- Fix developed privately
107+
- Coordinated disclosure after fix available
108+
- Security advisory published
109+
110+
See [SECURITY.md](SECURITY.md) for full details.
111+
112+
## Release Process
113+
114+
### Versioning
115+
116+
The project follows **Semantic Versioning** (SemVer):
117+
- **MAJOR**: Breaking API changes
118+
- **MINOR**: New features, backward compatible
119+
- **PATCH**: Bug fixes, backward compatible
120+
121+
**Current Version**: 1.6.1
122+
123+
### Release Cadence
124+
125+
- **Patch releases**: As needed for critical bugs
126+
- **Minor releases**: Every 4-8 weeks for new features
127+
- **Major releases**: When significant breaking changes accumulate
128+
129+
### Release Checklist
130+
131+
1. All tests passing (1,247+ tests)
132+
2. Coverage requirements met (83%+)
133+
3. Security scans clean
134+
4. Documentation updated
135+
5. CHANGELOG.md updated
136+
6. Version bumped in pyproject.toml and __init__.py
137+
7. Git tag created (v{version})
138+
8. PyPI package published
139+
9. GitHub release created
140+
141+
## Code of Conduct
142+
143+
### Principles
144+
145+
The Empathy Framework community values:
146+
- **Respectful communication**
147+
- **Constructive feedback**
148+
- **Inclusive participation**
149+
- **Professional behavior**
150+
- **Technical excellence**
151+
152+
### Expected Behavior
153+
154+
- Be respectful and considerate
155+
- Focus on technical merit
156+
- Accept constructive criticism
157+
- Acknowledge contributions
158+
- Help newcomers
159+
160+
### Unacceptable Behavior
161+
162+
- Harassment or discrimination
163+
- Personal attacks
164+
- Disruptive behavior
165+
- Spam or off-topic content
166+
- Violations of privacy
167+
168+
### Enforcement
169+
170+
The maintainer has the authority to:
171+
- Remove comments
172+
- Close issues/PRs
173+
- Block users (in extreme cases)
174+
- Ban contributors (for repeated violations)
175+
176+
## Contributing Guidelines
177+
178+
See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed contribution guidelines.
179+
180+
**Quick Summary**:
181+
1. Fork the repository
182+
2. Create a feature branch
183+
3. Make your changes with tests
184+
4. Ensure all tests pass
185+
5. Submit a pull request
186+
6. Respond to review feedback
187+
188+
## Communication Channels
189+
190+
### Primary
191+
192+
- **GitHub Issues**: Bug reports, feature requests
193+
- **GitHub Discussions**: General questions, ideas
194+
- **Pull Requests**: Code contributions
195+
- **Security Email**: [email protected] (private security reports)
196+
197+
### Future
198+
199+
As the community grows, we may add:
200+
- Discord/Slack community
201+
- Monthly community calls
202+
- Office hours for new contributors
203+
204+
## License and Intellectual Property
205+
206+
### Code License
207+
208+
All contributions to the Empathy Framework are licensed under **Fair Source 0.9**:
209+
- **Free**: For individuals, students, educators, and organizations with ≤5 employees
210+
- **Commercial**: $99/developer/year for organizations with 6+ employees
211+
212+
### Documentation License
213+
214+
Documentation is licensed under **Creative Commons Attribution 4.0 International (CC BY 4.0)**.
215+
216+
### Contributor License Agreement
217+
218+
By contributing to this project, you agree that:
219+
1. Your contributions will be licensed under Fair Source 0.9
220+
2. You have the right to contribute the code/documentation
221+
3. Deep Study AI, LLC may relicense the project if needed for sustainability
222+
223+
## Roadmap and Planning
224+
225+
### Current Focus (Q1 2025)
226+
227+
- ✅ 70% test coverage (ACHIEVED: 83.13%)
228+
- 🔄 90% test coverage target (229 lines remaining)
229+
- 🔄 OpenSSF Best Practices Badge
230+
- Production/Stable status (Development Status :: 5)
231+
232+
### Near-Term (Q1-Q2 2025)
233+
234+
- PyPI v2.0.0 release (after 90% coverage)
235+
- Claude Code partnership case study
236+
- MemDocs integration showcase
237+
- Book chapter publication (Q1 2026)
238+
239+
### Long-Term (2025-2026)
240+
241+
- Silver/Gold OpenSSF badges
242+
- Enterprise adoption case studies
243+
- Multi-model LLM support expansion
244+
- Domain-specific plugin ecosystem
245+
246+
## Changes to Governance
247+
248+
This governance document may be updated by the maintainer with:
249+
1. Advance notice (minimum 14 days)
250+
2. Rationale for changes
251+
3. Community input period
252+
4. Final decision documented
253+
254+
**Last Updated**: January 2025
255+
**Next Review**: July 2025 (or when contributor base exceeds 10 active contributors)
256+
257+
---
258+
259+
## Quick Reference
260+
261+
- **Maintainer**: Patrick Roebuck ([email protected])
262+
- **License**: Fair Source 0.9
263+
- **Code of Conduct**: Respectful, professional, inclusive
264+
- **Security**: Report privately to [email protected]
265+
- **Contributions**: Welcome via pull requests
266+
- **Releases**: Semantic versioning, regular cadence
267+
- **Community**: GitHub Issues/Discussions
268+
269+
For questions about governance, open a GitHub Discussion or contact the maintainer directly.

0 commit comments

Comments
 (0)