Contribuindo
Pré-requisitos
- Python 3.11+
- Gerenciador de pacotes uv
- Git
Desenvolvimento Local
# Clonar o repositório
git clone https://github.com/Zts0hg/codexspec:git
cd codexspec
# Instalar dependências de desenvolvimento
uv sync --dev
# Executar localmente
uv run codexspec --help
# Executar testes
uv run pytest
# Verificar código com linter
uv run ruff check src/
Documentação
# Instalar dependências de docs
uv sync --extra docs
# Visualizar documentação localmente
uv run mkdocs serve
# Construir documentação
uv run mkdocs build
Build
Processo de Pull Request
- Faça fork do repositório
- Crie uma branch de funcionalidade
- Faça suas alterações
- Execute testes e linting
- Envie um pull request
Estilo de Código
- Comprimento de linha: máximo 120 caracteres
- Siga PEP 8
- Use type hints para funções públicas