使用说明
{{项目名称}}
{{PROJECT_DESCRIPTION}}
安装
来源
git clone https://github.com/CrackingShells/{{PROJECT_NAME}}.git
cd {{PROJECT_NAME}}
pip install -e .
来自PyPI(如果可用)
pip install {{PROJECT_NAME}}
快速开始
import {{PACKAGE_NAME}}
# Add basic usage example here
发展
设置开发环境
# Clone the repository
git clone https://github.com/CrackingShells/{{PROJECT_NAME}}.git
cd {{PROJECT_NAME}}
# Install in development mode
pip install -e .
# Install Node.js dependencies for semantic release
npm install
运行测试
# Run all tests
python -m unittest discover tests
# Run specific test file
python -m unittest tests.test_basic
代码质量工具
设置自动代码质量检查:
# Install development dependencies
pip install -e .[dev]
# Set up pre-commit hooks
pre-commit install
# Run all checks manually
pre-commit run --all-files
安装后,预提交钩子将在每个 git commit 以确保代码质量。
建筑文件
在本地构建和提供文档:
# Serve documentation locally with live reload
mkdocs serve
# Build documentation for production
mkdocs build
当将更改推送到存储库时,文档会自动发布到ReadTheDocs。
作出承诺
我们使用 约定式提交 对于自动版本控制:
# Use commitizen for guided commits
npm run commit
# Or commit manually with conventional format
git commit -m "feat: add new feature"
git commit -m "fix: resolve issue with X"
git commit -m "docs: update README"
贡献
我们欢迎捐款!请查看我们的 贡献指南 有关以下内容的详细信息:
- 开发工作流程
- 代码风格指南
- 测试要求
- 拉取请求流程
许可证
此项目根据GNU Affero通用公共许可证v3获得许可-请参阅 许可证 文件以获取详细信息。
链接
- 首页: https://github.com/CrackingShells/{{项目名称}}
- 错误报告: https://github.com/CrackingShells/{{项目名称}}/问题
- 文档: https://crackingshells.github.io/{{项目名称}}/
