Hatch is the package manager for the Hatch! ecosystem. The documentation in docs/index.md is the canonical, up-to-date entry point for users and contributors — this README is a short pointer to those resources.
The major documentation entry points are:
- Documentation (canonical):
docs/index.md - Getting started (users):
docs/articles/users/GettingStarted.md - CLI reference:
docs/articles/users/CLIReference.md - Developer docs and architecture:
docs/articles/devs/index.md
But, really, just look at the site: https://crackingshells.github.io/Hatch/
git clone https://github.com/CrackingShells/Hatch.git
cd Hatch
pip install -e .hatch create my-package --description "My MCP server package"We welcome contributions! Please see our Contributing Guide for details.
- Fork and clone the repository
- Install dependencies:
pip install -e .andnpm install - Create a feature branch:
git checkout -b feat/your-feature - Make changes and add tests
- Use conventional commits:
npm run commitfor guided commits - Run tests:
python -c "import hatch; print('Hatch package imports successfully')" - Create a pull request
We use Conventional Commits for automated versioning:
feat: add new feature
fix: resolve bug
docs: update documentation
test: add tests
chore: maintenance tasksUse npm run commit for guided commit messages.
For detailed guidelines, see CONTRIBUTING.md.
- Read developer onboarding and contribution guides in
docs/articles/devs/ - Report issues or feature requests on the GitHub repository: https://github.com/CrackingShells/Hatch/issues
This project is licensed under the GNU Affero General Public License v3 — see LICENSE for details.
