Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
433 changes: 433 additions & 0 deletions .github/AI_INSTRUCTIONS.md

Large diffs are not rendered by default.

194 changes: 194 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,194 @@
# Guia de Contribuição

Obrigado por considerar contribuir para o Java4Beginners! 🎉

Este documento fornece diretrizes para contribuir com o projeto.

---

## 🤝 Como Contribuir

### Reportar Bugs ou Sugerir Melhorias

1. Verifique se já não existe uma issue sobre o assunto
2. Abra uma [nova issue](https://github.com/caramelotech/java4beginners/issues/new)
3. Descreva claramente o problema ou sugestão
4. Adicione exemplos quando possível

### Adicionar Conteúdo

1. **Fork** o repositório
2. **Clone** seu fork localmente
3. Crie uma **branch** para sua contribuição:

```bash
git checkout -b feature/meu-novo-conteudo
```

4. **Use o template** disponível em `.github/TEMPLATE.md`

5. **Adicione seu conteúdo** seguindo as diretrizes abaixo

6. **Commit** suas mudanças:

```bash
git add .
git commit -m "Adiciona conteúdo sobre [tópico]"
```

7. **Push** para seu fork:

```bash
git push origin feature/meu-novo-conteudo
```

8. Abra um **Pull Request** descrevendo suas mudanças

---

## 📝 Diretrizes de Conteúdo

### Estrutura dos Arquivos

- **Conteúdos educacionais:** `docs/XX-nome-do-topico.md`
- Onde XX é o número sequencial (01, 02, 03...)
- Use kebab-case para nomes de arquivo

- **Códigos de exemplo:** `codigos/XX-NomeDoExemplo/`
- Organize em pastas por tópico
- Inclua comentários explicativos

- **Recursos:** `recursos/README.md`
- Adicione livros, cursos, artigos relevantes
- Mantenha organizado por categoria

### Estilo de Escrita

- ✅ Use linguagem clara e acessível
- ✅ Explique conceitos complexos com analogias
- ✅ Inclua exemplos práticos
- ✅ Adicione código quando relevante
- ✅ Use formatação Markdown corretamente
- ❌ Evite jargões sem explicação
- ❌ Não assuma conhecimento prévio avançado
- ❌ Evite parágrafos muito longos

### Código

- ✅ Siga as convenções de código Java
- ✅ Adicione comentários explicativos
- ✅ Use nomes descritivos para variáveis/métodos
- ✅ Teste o código antes de submeter
- ✅ Inclua saída esperada quando aplicável

### Numeração

Ao adicionar novo conteúdo:

1. Verifique o último número usado em `docs/`
2. Use o próximo número sequencial
3. Atualize o índice em `docs/README.md`
4. Adicione links de navegação (anterior/próximo)

---

## 🎨 Template

Use sempre o template oficial em `.github/TEMPLATE.md` para criar novos conteúdos.

### Seções Obrigatórias

- Introdução
- Explicação do conceito
- Exemplos práticos
- Exercícios (quando aplicável)

### Seções Opcionais

- Recursos adicionais
- Perguntas frequentes
- Conceitos relacionados

---

## 🔍 Revisão

Antes de submeter seu PR:

- [ ] Revisei ortografia e gramática
- [ ] Testei todos os links
- [ ] Executei e testei códigos de exemplo
- [ ] Segui o template oficial
- [ ] Atualizei o índice/README quando necessário
- [ ] Adicionei metadados (nível, tempo de leitura)

---

## 📋 Tipos de Contribuição

### Conteúdo Educacional

- Novos tópicos sobre Java
- Tutoriais práticos
- Guias de conceitos

### Código

- Exemplos práticos
- Exercícios resolvidos
- Projetos de referência

### Recursos

- Livros recomendados
- Cursos online
- Artigos e vídeos
- Ferramentas úteis

### Melhorias

- Correções de erros
- Melhorias de texto
- Atualização de links
- Otimização de exemplos

---

## 🌟 Boas Práticas

1. **Seja consistente** com o estilo existente
2. **Teste tudo** antes de submeter
3. **Documente bem** seu código
4. **Seja didático** - lembre-se do público iniciante
5. **Mantenha simples** - prefira clareza à complexidade
6. **Cite fontes** quando usar conteúdo de terceiros

---

## ❓ Dúvidas

Se tiver dúvidas sobre como contribuir:

1. Consulte os [exemplos existentes](../docs/)
2. Leia outros PRs aprovados
3. Abra uma issue para discussão
4. Entre em contato com os mantenedores

---

## 📜 Código de Conduta

- Seja respeitoso e profissional
- Aceite críticas construtivas
- Foque no melhor para o projeto
- Ajude outros contribuidores

---

## 🙏 Agradecimentos

Toda contribuição é valiosa! Obrigado por ajudar a tornar o aprendizado de Java mais acessível.

---

**[⬅️ Voltar ao README](../README.md)**
62 changes: 62 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
## Descrição

<!-- Descreva resumidamente o que esta PR adiciona/altera/corrige -->

---

## Tipo de Mudança

<!-- Marque com [x] o tipo de mudança desta PR -->

- [ ] 📝 Novo conteúdo educacional
- [ ] 🐛 Correção de erro (typo, link quebrado, etc.)
- [ ] ✨ Melhoria de conteúdo existente
- [ ] 💻 Novo código de exemplo
- [ ] 📚 Adição de recursos (livros, cursos, etc.)
- [ ] 🔧 Configuração ou estrutura do repositório
- [ ] 📖 Atualização de documentação

---

## Checklist

<!-- Marque com [x] os itens concluídos -->

- [ ] Segui as [diretrizes de contribuição](../CONTRIBUTING.md)
- [ ] Usei o [template adequado](TEMPLATE.md) (se aplicável)
- [ ] Revisei ortografia e gramática
- [ ] Verifiquei que os links estão funcionando
- [ ] Testei os códigos de exemplo (se aplicável)
- [ ] Adicionei/atualizei o índice (README.md) se necessário
- [ ] O conteúdo está numerado corretamente (se novo tópico)

---

## Conteúdo Adicionado/Modificado

<!-- Liste os arquivos principais afetados -->

- [ ] `docs/XX-nome-do-topico.md`
- [ ] `codigos/exemplo.java`
- [ ] `recursos/README.md`
- [ ] Outro:

---

## Screenshots

<!-- Se aplicável, adicione screenshots da renderização do conteúdo -->

---

## Informações Adicionais

<!-- Qualquer contexto adicional sobre a PR -->

---

## Revisores

<!-- @mencione revisores específicos se necessário -->

cc: @caramelotech
Loading