Skip to content

Commit 16ed481

Browse files
authored
fix: update formatting (#2)
- update he4rt logo - add codeowners to the project - named lists - update config description - update author links - add local development section
1 parent ea85e13 commit 16ed481

27 files changed

+168
-271
lines changed

.github/CODEOWNERS

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Global rule
2+
3+
* @vcwild @VictorMPicoli

README.md

+29-16
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,18 @@
1515

1616
<img src=".github/qa.gif" alt="Imagem de QA" width="150">
1717
</br>
18-
<img src="https://img.shields.io/github/workflow/status/vcwild/qa4noobs/deploy?style=flat-square&color=blueviolet" alt="build" />
19-
<img src="https://img.shields.io/badge/topics-42-blueviolet?style=flat-square" alt="topics" />
20-
<img src="https://img.shields.io/tokei/lines/github/vcwild/qa4noobs?color=blueviolet&style=flat-square" alt="topics" />
21-
<img src="https://img.shields.io/github/license/vcwild/qa4noobs?color=blueviolet&style=flat-square" alt="license" />
18+
<img src="https://img.shields.io/github/workflow/status/vcwild/qa4noobs/deploy?style=flat-square&color=9468cc" alt="build" />
19+
<img src="https://img.shields.io/badge/topics-42-9468cc?style=flat-square" alt="topics" />
20+
<img src="https://img.shields.io/tokei/lines/github/vcwild/qa4noobs?color=9468cc&style=flat-square" alt="topics" />
21+
<img src="https://img.shields.io/github/license/vcwild/qa4noobs?color=9468cc&style=flat-square" alt="license" />
2222

2323
</h1>
2424

25-
<p align="center">
25+
<h2 align="center">
2626
<a href="https://vcwild.github.io/qa4noobs/" > <strong>Veja o projeto na íntegra »</strong></a>
27-
<br />
28-
<br />
27+
</h2>
28+
<br />
29+
<p align="center">
2930
<a href="#about">Sobre</a> •
3031
<a href="#ROADMAP">Roadmap •</a>
3132
<a href="#contribute">Contribua</a> •
@@ -135,19 +136,31 @@ são **extremamente apreciadas**
135136
4. Realize o Push no Branch (`git push origin feature/featureBraba`)
136137
5. Abra um Pull Request
137138

139+
### Desenvolvimento local <a id="development"></a>
140+
141+
Para rodar o projeto localmente, você precisa ter o [Node.js](https://nodejs.org/en/) instalado na sua máquina. Também recomendamos utilizar o [Yarn](https://yarnpkg.com/) como gerenciador de pacotes.
142+
143+
Adicione as variáveis de ambiente ao seu path:
144+
145+
```sh
146+
source scripts/enviroment.sh
147+
```
148+
149+
Rode os comandos:
150+
151+
```sh
152+
# instalar dependências
153+
yarn
154+
155+
# servir com hot reload em localhost:8080
156+
yarn dev
157+
```
158+
138159
## 💁‍♂️ Autores <a id="author"></a>
139160

140-
- **Victor Manoel** - _Software Quality Engineer_ - [@TTVKeeabo](https://www.twitch.tv/keeabo)
161+
- **Victor Manoel** - _Software Quality Engineer_ - [@Keeabo](https://www.linkedin.com/in/victor-manoel-0b4413191/)
141162
- **Victor Wildner** - _Software Quality Engineer_ - [@vcwild](https://twitter.com/vcwild)
142163

143164
## 🏷️ Licença <a id="license"></a>
144165

145166
O projeto está sob a licença AGPL-3.0. Veja o arquivo [LICENSE](LICENSE) para mais detalhes.
146-
147-
---
148-
149-
<p align="center">
150-
<a href="https://github.com/he4rt/4noobs" target="_blank">
151-
<img src="docs/.vuepress/public/images/footer_4noobs.svg" width="380">
152-
</a>
153-
</p>

docs/.vuepress/config.js

+3-2
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,16 @@ module.exports = {
22
base: "/qa4noobs/",
33
title: "Curso de QA da He4rt Developers",
44
theme: "yuu",
5-
description: "QA",
5+
description: "Um guia prático de testes para iniciantes",
66
themeConfig: {
77
yuu: {
88
defaultDarkTheme: true,
99
defaultColorTheme: "purple",
1010
},
1111
nav: [
1212
{ text: "Home", link: "/" },
13-
{ text: "Docs", link: "/guide/" },
13+
{ text: "Guia", link: "/guide/" },
14+
{ text: "Colaborar", link: "https://github.com/vcwild/qa4noobs" },
1415
{ text: "He4rt", link: "https://twitter.com/He4rtDevs" }
1516
],
1617
sidebar: {
+2-125
Loading

docs/00-fundacao/05-identificar.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# **Como Identificar o que Testar**
1+
# Como Identificar o que Testar
22

33
Durante o processo de testes é necessário identificar o que deve ser testado, para isso, é necessário entender o que é um teste, e como ele é realizado.
44

5-
## *As 3 Principais formas de Documentar um Teste*
5+
## As 3 Principais formas de Documentar um Teste
66

77
Vamos entender as 3 formas de documentar um teste, para que possamos entender como identificar o que deve ser testado.
88

@@ -21,7 +21,7 @@ Tipo menos detalhado de documentação, descrição de objetivo que o usuário p
2121

2222
Pode ser feito o uso de todos estas modalidades, muitas vezes simultâneamente, e divida entre a equipe com base em suas diferentes habilidades e competências dentro do contexto específico do projeto.
2323

24-
## *Como identificar o que testar*
24+
## Como identificar o que testar
2525

2626
Vamos entender as diferentes formas de testar.
2727

docs/00-fundacao/06-casos-relator-incidentes.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# **Casos de Teste, Relatos de Incidentes e Prioridades**
1+
# Casos de Teste, Relatos de Incidentes e Prioridades
22

33
Quando realizamos testes, é necessário que sejam escritos os casos de testes, para que possamos realizar os testes de forma organizada e padronizada. Devemos também relatar os incidentes encontrados, para que possamos corrigi-los e garantir a qualidade do software. Além de priorizar os incidentes encontrados, para que possamos corrigi-los de acordo com a sua importância.
44

5-
## *Como escrever casos de testes a partir de uma historia de usuário*
5+
## Como escrever casos de testes a partir de uma historia de usuário
66

77
- O que são histórias de usuários
88

@@ -18,7 +18,7 @@ São escritas em algumas frases com linguagem simples que delimitam o resultado
1818
**Eu** quero que sejam disponibilizadas diversas formas de pagamento
1919
**Para** pagar meu pedido
2020

21-
## *Especificação dos Casos de Teste*
21+
## Especificação dos Casos de Teste
2222

2323
Como se escreve um caso de teste?
2424

@@ -32,7 +32,7 @@ O caso deve ser autossuficiente, incluindo todas as informações necessárias p
3232

3333
Também é necessário incluir com entradas válidas e não esperadas, bem como entradas válidas e esperadas.
3434

35-
## *Classificação de Bugs: Severidade e Prioridade*
35+
## Classificação de Bugs: Severidade e Prioridade
3636

3737
- Severidade: Define o grau ou intensidade de um defeito no que se refere ao seu impacto no software e seu funcionamento.
3838
- S1 - Crítica/ShowStopper: Bloqueio no teste ou funcionalidade que causa crash na aplicação ou principais caso de uso de funcionalidades chave, questões de segurança, perda grave no salvamento de dados. Bloqueios que impedem o teste de outras funções;

0 commit comments

Comments
 (0)