https://github.com/ultralytics/pre-commit
Ultralytics pre-commit hooks
https://github.com/ultralytics/pre-commit
hooks hub pre-commit ultralytics yolo
Last synced: 6 months ago
JSON representation
Ultralytics pre-commit hooks
- Host: GitHub
- URL: https://github.com/ultralytics/pre-commit
- Owner: ultralytics
- License: agpl-3.0
- Created: 2023-10-12T19:23:05.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-28T01:53:39.000Z (7 months ago)
- Last Synced: 2025-03-28T02:39:48.720Z (7 months ago)
- Topics: hooks, hub, pre-commit, ultralytics, yolo
- Language: Python
- Homepage: https://ultralytics.com
- Size: 52.7 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🛠️ Ultralytics Pre-commit Hooks
Welcome to the Ultralytics pre-commit hooks repository! This collection features hooks developed by [Ultralytics](https://www.ultralytics.com/) to enforce code quality and maintain consistent standards across our software projects. Integrating these hooks into your development workflow automates code validation, ensuring a high level of code hygiene and reducing manual review efforts. Learn more about the [pre-commit framework](https://pre-commit.com/) itself on their official website.
[](https://github.com/ultralytics/pre-commit/actions/workflows/format.yml)
[](https://discord.com/invite/ultralytics)
[](https://community.ultralytics.com/)
[](https://reddit.com/r/ultralytics)
## 🗂️ Repository Structure
This repository is organized for clarity and ease of use:
- **`hooks/` directory:** Contains individual [Python](https://www.python.org/) scripts, each representing a distinct pre-commit hook designed for specific checks or code formatting tasks.
- **`.pre-commit-hooks.yaml`:** The root configuration file defining the available hooks, making them discoverable and easy to integrate into your projects.
### Hook Scripts in `hooks` Directory 📂
Each script within the `hooks` directory is a standalone Python program performing a specific pre-commit task. For instance:
- `capitalize_comments.py`: Ensures that standalone inline comments start with a capital letter, promoting readability and a professional coding style.
### Defining Hooks in `.pre-commit-hooks.yaml` 📘
The `.pre-commit-hooks.yaml` file lists all installable hooks. Here's an example structure for a hook definition:
```yaml
- id: hook-id # Unique identifier for the hook
name: "A descriptive name for the hook" # User-friendly name
entry: hooks/your_hook_script.py # Path to the hook script
language: python # Specifies the language the script is written in
types: [python] # File types the hook should run on
```
## ➕ Adding New Hooks
Interested in contributing a new hook? Follow these steps:
1. **Create Your Hook Script:** Develop a Python script implementing your desired check or formatting logic. Place it in the `hooks/` directory. Ensure your script includes clear error messages and handles potential edge cases.
2. **Declare the Hook:** Add a new entry for your hook in the `.pre-commit-hooks.yaml` file, following the structure shown above.
3. **Test Locally:** Thoroughly test your hook in a local project environment using `pre-commit run --all-files` to confirm it works as expected before submitting.
4. **Submit Your Contribution:** Commit your changes and create a Pull Request to the repository. Adhering to our [contribution guidelines](https://docs.ultralytics.com/help/contributing/) is appreciated.
## 🔧 Installing Hooks in Your Project
To use Ultralytics pre-commit hooks in your own project, add the following to your project's `.pre-commit-config.yaml` file:
```yaml
repos:
- repo: https://github.com/ultralytics/pre-commit-hooks
rev: main # Pin to 'main' for the latest, or a specific git tag/commit SHA for stability
hooks:
- id: capitalize-comments # Example: Use the ID of the hook you want to include
# Add other hook IDs as needed
```
After updating your configuration, run this command in your project's root directory to install the hooks:
```bash
pre-commit install
```
Now, the specified Ultralytics hooks will automatically run on your staged files each time you commit, helping maintain code quality effortlessly as part of your [Continuous Integration (CI)](https://www.ultralytics.com/glossary/continuous-integration-ci) process.
## 💡 Contribute
Ultralytics values community contributions! Your involvement helps us improve and grow. Please review our [Contributing Guide](https://docs.ultralytics.com/help/contributing/) for detailed information on how to participate. We also encourage you to share your feedback through our [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A big thank you 🙏 to all our contributors! Check out some [tips on contributing to open-source projects](https://www.ultralytics.com/blog/tips-to-start-contributing-to-ultralytics-open-source-projects) on our blog.
[](https://github.com/ultralytics/ultralytics/graphs/contributors)
## 📄 License
Ultralytics offers two licensing options:
- **AGPL-3.0 License:** An [OSI-approved](https://opensource.org/license/agpl-v3) open-source license ideal for students, researchers, and enthusiasts who value open collaboration. See the [LICENSE](https://github.com/ultralytics/ultralytics/blob/main/LICENSE) file for details.
- **Enterprise License:** Designed for commercial use, this license allows seamless integration of Ultralytics software and AI models into commercial products and services, bypassing the open-source requirements of AGPL-3.0. For inquiries, visit [Ultralytics Licensing](https://www.ultralytics.com/license).
## 📮 Contact
For bug reports or feature requests related to Ultralytics pre-commit hooks, please submit an issue on [GitHub Issues](https://github.com/ultralytics/pre-commit/issues). For general questions and discussions, join our vibrant community on [Discord](https://discord.com/invite/ultralytics)!
