Skip to content

Commit b0d1a0c

Browse files
feluryefelurye
authored
Merge pull request #1 from caramelotech/copilot/introducao-a-linguagem-java
Bootstrap Java knowledge base with structured content system and GitHub Pages
2 parents 885e797 + 344884c commit b0d1a0c

18 files changed

Lines changed: 3006 additions & 2 deletions

‎.github/AI_INSTRUCTIONS.md‎

Lines changed: 417 additions & 0 deletions
Large diffs are not rendered by default.

‎.github/CONTRIBUTING.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Guia de Contribuição
2+
3+
Obrigado por querer contribuir com o Java Labs!
4+
5+
## O que pode ser contribuido
6+
7+
- Melhorias e correções nos conteúdos (`/notes`)
8+
- Novos exemplos de código em `/examples`
9+
- Exercícios adicionais em `/exercicios`
10+
- Projetos práticos em `/projetos`
11+
- Recursos recomendados em `/recursos`
12+
13+
## Processo
14+
15+
1. Crie uma branch a partir de `main` seguindo o padrão:
16+
```
17+
feature/descricao-curta
18+
fix/descricao-curta
19+
docs/descricao-curta
20+
```
21+
22+
2. Faça commits atômicos com mensagens no padrão de Conventional Commits:
23+
```
24+
feat: adicionar exercícios sobre loops
25+
fix: corrigir exemplo de recursão
26+
docs: melhorar conteúdo sobre herança
27+
```
28+
29+
Tipos válidos: `feat`, `fix`, `docs`, `style`, `refactor`, `chore`
30+
31+
3. Abra um Pull Request usando o template disponível e aguarde revisão.
32+
33+
4. Após aprovação, o merge será feito por um mantenedor.
34+
35+
## Padrões de conteúdo
36+
37+
### Documentação (Markdown)
38+
39+
- Escreva em português (pt-BR)
40+
- Use títulos hierárquicos (`##`, `###`)
41+
- Prefira exemplos curtos e diretos
42+
- Inclua o "por quê", não apenas o "como"
43+
- Nomeie os arquivos com prefixo numérico sequencial: `03-nome-do-topico.md`
44+
- Atualize o índice em `notes/README.md` ao adicionar um novo tópico
45+
46+
### Exemplos de código (`/examples`)
47+
48+
- Um conceito por pasta, nomeada com prefixo sequencial: `02-NomeDoExemplo/`
49+
- Inclua um comentário no topo do arquivo explicando o que o exemplo demonstra
50+
- Adicione um `README.md` na pasta com instruções de execução
51+
- Teste o código antes de submeter: `javac Arquivo.java && java Arquivo`
52+
53+
### Exercícios (`/exercicios`)
54+
55+
- Descreva claramente o objetivo
56+
- Indique o nível de dificuldade (iniciante / intermediário / avançado)
57+
- Inclua exemplos de saída esperada
58+
- Use critérios de sucesso em formato de checklist
59+
60+
### Projetos (`/projetos`)
61+
62+
- Descreva o objetivo e o contexto
63+
- Liste os requisitos em formato de checklist
64+
- Inclua ao menos um exemplo de uso ou saída esperada
65+
- Adicione dicas para quem está começando
66+
67+
## Dúvidas?
68+
69+
Abra uma issue com a tag `question`.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## O que este PR faz?
2+
3+
<!-- Descreva de forma clara e objetiva o que foi adicionado, alterado ou corrigido. -->
4+
5+
## Tipo de mudança
6+
7+
- [ ] Novo conteúdo (`/docs`)
8+
- [ ] Novo exemplo de código (`/codigos`)
9+
- [ ] Novo exercício (`/exercicios`)
10+
- [ ] Novo projeto (`/projetos`)
11+
- [ ] Recurso recomendado (`/recursos`)
12+
- [ ] Correção de conteúdo existente
13+
- [ ] Outro: <!-- descreva -->
14+
15+
## Checklist
16+
17+
- [ ] O conteúdo está em português
18+
- [ ] Os arquivos estão no diretório correto
19+
- [ ] Exemplos de código compilam e executam sem erros
20+
- [ ] Exercícios e projetos têm objetivo e critérios de sucesso descritos
21+
- [ ] O índice (`notes/README.md`) foi atualizado, se necessário
22+
- [ ] Minha branch está atualizada com `main`
23+
- [ ] Não há conflitos de merge
24+
25+
## Contexto adicional
26+
27+
<!-- Alguma decisão de design, referência externa ou ponto que o revisor deve saber? Deixe em branco se não houver. -->

‎.github/TEMPLATE.md‎

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
# [Número] - [Título do Tópico]
2+
3+
> **Última atualização:** [Data]
4+
> **Nível:** [Iniciante/Intermediário/Avançado]
5+
> **Tempo de leitura:** [X minutos]
6+
7+
## Introdução
8+
9+
[Breve introdução ao tópico - 2-3 parágrafos explicando o que será abordado e por que é importante]
10+
11+
## O que é [Tópico]?
12+
13+
[Definição clara e objetiva do conceito principal]
14+
15+
### Conceitos Básicos
16+
17+
[Explicação dos conceitos fundamentais usando linguagem simples]
18+
19+
#### Analogia
20+
21+
[Usar analogias do dia a dia para facilitar o entendimento. Exemplo: "Imagine que..."]
22+
23+
## Como Funciona
24+
25+
[Explicação detalhada de como o conceito funciona na prática]
26+
27+
### Exemplo Prático
28+
29+
[Incluir exemplos concretos e aplicáveis]
30+
31+
```java
32+
// Código de exemplo em Java
33+
public class Exemplo {
34+
public static void main(String[] args) {
35+
// Seu código aqui
36+
}
37+
}
38+
```
39+
40+
## Principais Características
41+
42+
- **Característica 1:** [Descrição]
43+
- **Característica 2:** [Descrição]
44+
- **Característica 3:** [Descrição]
45+
46+
## Aplicações Práticas
47+
48+
[Lista de aplicações práticas do conceito]
49+
50+
1. **Aplicação 1:** [Descrição]
51+
2. **Aplicação 2:** [Descrição]
52+
3. **Aplicação 3:** [Descrição]
53+
54+
## Exemplos de Código
55+
56+
### Exemplo 1: [Nome do Exemplo]
57+
58+
```java
59+
// Código do exemplo
60+
```
61+
62+
**Explicação:**
63+
[Explicação linha por linha ou conceitual do código]
64+
65+
## Conceitos Relacionados
66+
67+
[Links para outros tópicos relacionados no repositório]
68+
69+
- [📖 Tópico Anterior](../notes/XX-topico-anterior.md)
70+
- [📖 Tópico Relacionado](../notes/XX-topico-relacionado.md)
71+
- [📖 Próximo Tópico](../notes/XX-proximo-topico.md)
72+
73+
## Recursos Adicionais
74+
75+
### Para Aprender Mais
76+
77+
- 📚 **Livros:**
78+
- [Nome do Livro](link) - [Breve descrição]
79+
- 🎓 **Cursos:**
80+
- [Nome do Curso](link) - [Plataforma] - [Nível]
81+
- 📹 **Vídeos:**
82+
- [Título do Vídeo](link) - [Canal/Criador]
83+
- 📰 **Artigos:**
84+
- [Título do Artigo](link) - [Autor/Fonte]
85+
86+
### Ferramentas Práticas
87+
88+
- [Nome da Ferramenta](link) - [Descrição breve]
89+
90+
## Exercícios Práticos
91+
92+
### Exercício 1: [Nome do Exercício]
93+
94+
**Objetivo:** [Descrição do objetivo]
95+
96+
**Instruções:**
97+
98+
1. [Passo 1]
99+
2. [Passo 2]
100+
3. [Passo 3]
101+
102+
**Dica:** [Dica para resolução]
103+
104+
### Exercício 2: [Nome do Exercício]
105+
106+
**Objetivo:** [Descrição do objetivo]
107+
108+
**Instruções:**
109+
110+
1. [Passo 1]
111+
2. [Passo 2]
112+
113+
## Perguntas Frequentes
114+
115+
<details>
116+
<summary><strong>Pergunta 1?</strong></summary>
117+
118+
Resposta detalhada para a pergunta 1.
119+
120+
</details>
121+
122+
<details>
123+
<summary><strong>Pergunta 2?</strong></summary>
124+
125+
Resposta detalhada para a pergunta 2.
126+
127+
</details>
128+
129+
## Resumo
130+
131+
[Resumo dos pontos principais abordados neste tópico em bullet points]
132+
133+
- Ponto 1
134+
- Ponto 2
135+
- Ponto 3
136+
137+
## Próximos Passos
138+
139+
[Sugestões do que estudar em seguida]
140+
141+
1. [Próximo tópico recomendado](link)
142+
2. [Prática recomendada](link)
143+
144+
**[⬅️ Voltar ao Índice](../README.md)** | **[➡️ Próximo Tópico](link)**

‎.gitignore‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Compiled class files
2+
*.class
3+
4+
# Log files
5+
*.log
6+
7+
# BlueJ files
8+
*.ctxt
9+
10+
# Mobile Tools for Java (J2ME)
11+
.mtj.tmp/
12+
13+
# Package Files
14+
*.jar
15+
*.war
16+
*.nar
17+
*.ear
18+
*.zip
19+
*.tar.gz
20+
*.rar
21+
22+
# Virtual machine crash logs
23+
hs_err_pid*
24+
replay_pid*
25+
26+
# Eclipse
27+
.classpath
28+
.project
29+
.settings/
30+
bin/
31+
32+
# IntelliJ IDEA
33+
.idea/
34+
*.iml
35+
*.iws
36+
*.ipr
37+
out/
38+
39+
# NetBeans
40+
nbproject/
41+
build/
42+
nbbuild/
43+
dist/
44+
nbdist/
45+
.nb-gradle/
46+
47+
# VS Code
48+
.vscode/
49+
*.code-workspace
50+
51+
# Maven
52+
target/
53+
pom.xml.tag
54+
pom.xml.releaseBackup
55+
pom.xml.versionsBackup
56+
pom.xml.next
57+
release.properties
58+
dependency-reduced-pom.xml
59+
buildNumber.properties
60+
.mvn/timing.properties
61+
.mvn/wrapper/maven-wrapper.jar
62+
63+
# Gradle
64+
.gradle/
65+
build/
66+
!gradle-wrapper.jar
67+
68+
# macOS
69+
.DS_Store
70+
.AppleDouble
71+
.LSOverride
72+
73+
# Windows
74+
Thumbs.db
75+
ehthumbs.db
76+
Desktop.ini
77+
$RECYCLE.BIN/
78+
79+
# Linux
80+
*~
81+
.directory
82+
83+
# Temporary files
84+
*.tmp
85+
*.bak
86+
*.swp
87+
*~.nib
88+
local.properties
89+
90+
# Node (for any web tools)
91+
node_modules/
92+
npm-debug.log*
93+
94+
# Jekyll
95+
_site/
96+
.sass-cache/
97+
.jekyll-cache/
98+
.jekyll-metadata

0 commit comments

Comments
 (0)