Skip to content

Commit da1b746

Browse files
semsem
sem
authored and
sem
committed
Add release documentation and community files
- Add comprehensive CHANGELOG.md for v2.0.0 - Add MIT LICENSE - Add Contributor Covenant CODE_OF_CONDUCT.md - Add CONTRIBUTING.md with guidelines - Prepare for first official release
1 parent 49e6a75 commit da1b746

4 files changed

Lines changed: 322 additions & 0 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Changelog
2+
3+
All notable changes to Claude Code Hooks will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [2.0.0] - 2025-01-03
9+
10+
### 🎉 Major Release - Comprehensive Hook Collection
11+
12+
This release introduces a complete set of 16 production-ready hooks for Claude Code, designed to enforce coding standards, maintain consistency, and automate workflow tasks.
13+
14+
### Added
15+
16+
#### 🆕 New Advanced Hooks
17+
- **api-docs-enforcer.py** - Ensures API documentation completeness with Swagger/OpenAPI
18+
- **no-mock-code.py** - Prevents placeholder/mock code in production
19+
- **secret-scanner.py** - Detects and blocks secrets from being committed
20+
- **env-sync-validator.py** - Keeps .env and .env.example synchronized
21+
- **gitignore-enforcer.py** - Ensures proper .gitignore configuration
22+
- **readme-update-validator.py** - Reminds to update docs when features change
23+
24+
#### 🧪 Testing Infrastructure
25+
- Comprehensive test suite (`test_hooks.py`)
26+
- Simple test runner (`run_tests.sh`)
27+
- npm test support via `package.json`
28+
- All hooks have automated tests
29+
30+
#### 📚 Documentation
31+
- Enhanced README with badges and status indicators
32+
- Detailed accordion sections for each hook
33+
- User-friendly explanations in plain English
34+
- Practical examples for every hook
35+
- Professional banner images
36+
37+
### Changed
38+
- Made `validate-dart-task.py` generic and customizable
39+
- Made `sync-docs-to-dart.py` project-agnostic
40+
- Improved error messages across all hooks
41+
- Enhanced hook output formatting
42+
43+
### Fixed
44+
- Removed project-specific references
45+
- Fixed missing imports in various hooks
46+
- Improved hook reliability and error handling
47+
48+
### Security
49+
- Added comprehensive secret scanning
50+
- Enforced .gitignore best practices
51+
- API security validation for internal endpoints
52+
53+
## [1.0.0] - 2024-12-15
54+
55+
### Added
56+
- Initial set of 10 core hooks:
57+
- pre-commit-validator.py
58+
- validate-git-commit.py
59+
- database-extension-check.py
60+
- duplicate-detector.py
61+
- style-consistency.py
62+
- api-endpoint-verifier.py
63+
- validate-dart-task.py
64+
- sync-docs-to-dart.py
65+
- log-commands.py
66+
- mcp-tool-enforcer.py
67+
- session-end-summary.py
68+
- Basic installation script
69+
- Initial documentation

‎CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[INSERT CONTACT EMAIL].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Contributing to Claude Code Hooks
2+
3+
Thank you for your interest in contributing to Claude Code Hooks! This project aims to help developers maintain high-quality code through automated hooks.
4+
5+
## Code of Conduct
6+
7+
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
8+
9+
## How Can I Contribute?
10+
11+
### Reporting Bugs
12+
13+
Before creating bug reports, please check existing issues to avoid duplicates. When you create a bug report, include as many details as possible:
14+
15+
* Use a clear and descriptive title
16+
* Describe the exact steps to reproduce the problem
17+
* Provide specific examples to demonstrate the steps
18+
* Describe the behavior you observed and what you expected
19+
* Include your system details (OS, Python version, Claude Code version)
20+
21+
### Suggesting Enhancements
22+
23+
Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion:
24+
25+
* Use a clear and descriptive title
26+
* Provide a detailed description of the suggested enhancement
27+
* Provide specific examples to demonstrate how it would work
28+
* Explain why this enhancement would be useful
29+
30+
### Creating New Hooks
31+
32+
We welcome new hook contributions! When creating a new hook:
33+
34+
1. **Follow the Pattern**: Look at existing hooks for the structure
35+
2. **Document Your Hook**: Include a docstring explaining what it does
36+
3. **Add Tests**: Create tests in `test_hooks.py`
37+
4. **Update Documentation**: Add your hook to the README.md
38+
39+
#### Hook Guidelines
40+
41+
* Exit code 0: Success/warning (non-blocking)
42+
* Exit code 2: Error (blocks operation)
43+
* Output messages to stderr
44+
* Be helpful in error messages - explain how to fix issues
45+
* Keep performance in mind - hooks run frequently
46+
47+
### Pull Requests
48+
49+
1. Fork the repository
50+
2. Create your feature branch (`git checkout -b feature/amazing-hook`)
51+
3. Make your changes
52+
4. Run tests (`npm test`)
53+
5. Commit your changes using a descriptive commit message
54+
6. Push to your branch
55+
7. Open a Pull Request
56+
57+
#### Pull Request Guidelines
58+
59+
* Include a clear description of the changes
60+
* Reference any related issues
61+
* Update tests as needed
62+
* Update documentation if you're changing functionality
63+
* Ensure all tests pass
64+
65+
## Development Setup
66+
67+
1. Clone your fork:
68+
```bash
69+
git clone https://github.com/your-username/claude-hooks.git
70+
cd claude-hooks
71+
```
72+
73+
2. Install the hooks locally for testing:
74+
```bash
75+
./install.sh
76+
```
77+
78+
3. Run tests:
79+
```bash
80+
npm test
81+
# or for detailed output
82+
python3 test_hooks.py
83+
```
84+
85+
## Testing Your Hook
86+
87+
1. Create a test case in `test_hooks.py`
88+
2. Test manually with sample input:
89+
```bash
90+
echo '{"tool_name":"Write","tool_input":{"file_path":"test.js","content":"test"}}' | python3 your-hook.py
91+
```
92+
3. Ensure it handles edge cases gracefully
93+
94+
## Style Guide
95+
96+
* Use Python 3.6+ compatible code
97+
* Follow PEP 8 style guidelines
98+
* Use descriptive variable names
99+
* Add comments for complex logic
100+
* Keep functions focused and small
101+
102+
## Questions?
103+
104+
Feel free to open an issue for any questions about contributing!

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024-2025 Claude Code Hooks Contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)