Skip to content

Commit 2a338ea

Browse files
atualizando CONTRIBUTING.md com testes para Windows (#500)
1 parent 59d491b commit 2a338ea

File tree

2 files changed

+67
-1
lines changed

2 files changed

+67
-1
lines changed

CONTRIBUTING.md

Lines changed: 63 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,10 @@ pip install -r requirements-dev.txt
143143

144144
Agora você pode usá-lo [da mesma forma descrita no arquivo README.md](/README.md#utilização).
145145

146-
#### Testes
146+
147+
148+
149+
# Testes
147150

148151
Execute os testes através do seguinte comando:
149152

@@ -162,6 +165,65 @@ OK
162165

163166
Certifique-se de que o retorno é `OK`, o quê indica todos os testes estão passando e que não tem nenhum falhando.
164167

168+
---
169+
170+
## Testes no Windows
171+
172+
Caso os testes não funcionem ou se você precisar configurar o ambiente do zero, siga as etapas abaixo para preparar o ambiente no Windows.
173+
174+
### Instalar o Chocolatey
175+
176+
Primeiro, abra o PowerShell como administrador e execute o seguinte comando para instalar o **Chocolatey**, que é um gerenciador de pacotes para o Windows:
177+
178+
```powershell
179+
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))
180+
```
181+
182+
### Instalar o `make`
183+
184+
Após a instalação do Chocolatey, instale o **make** com o seguinte comando:
185+
186+
```powershell
187+
choco install make
188+
```
189+
190+
Verifique se o `make` foi instalado corretamente com:
191+
192+
```powershell
193+
where.exe make
194+
```
195+
196+
### Instalar o Poetry
197+
198+
Instale o **Poetry**, que é uma ferramenta de gerenciamento de dependências e ambientes Python, usando o comando:
199+
200+
```powershell
201+
choco install poetry
202+
```
203+
204+
### Instalar as dependências do projeto
205+
206+
Dentro do diretório do seu projeto, abra o terminal e instale as dependências do projeto usando o **Poetry**:
207+
208+
```powershell
209+
poetry install
210+
```
211+
212+
### Verificar e configurar o `Makefile`
213+
214+
No arquivo `Makefile` do seu projeto, verifique se a seção de testes está configurada corretamente. Se estiver no Windows, use a seguinte configuração para o alvo `test`:
215+
216+
```makefile
217+
test:
218+
ifeq ($(OS),Windows_NT)
219+
@set PYTHONDONTWRITEBYTECODE=1 && poetry run python -m unittest discover tests/ -v
220+
else
221+
@PYTHONDONTWRITEBYTECODE=1 poetry run python3 -m unittest discover tests/ -v
222+
endif
223+
```
224+
225+
226+
165227
### 8. Faça as Suas Alterações
166228

167229
Agora é a etapa em que você pode implementar as suas alterações no código.

Makefile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,8 @@ check:
2222
@poetry run ruff check .
2323

2424
test:
25+
ifeq ($(OS),Windows_NT)
26+
@set PYTHONDONTWRITEBYTECODE=1 && poetry run python -m unittest discover tests/ -v
27+
else
2528
@PYTHONDONTWRITEBYTECODE=1 poetry run python3 -m unittest discover tests/ -v
29+
endif

0 commit comments

Comments
 (0)