Skip to content
Merged
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
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
* @cumbucadev/cumbuca-s-core-team @cumbucadev/cumbuca-s-maintainers
* @cumbucadev/nucle-documentacao
* @cumbucadev/nucle-documentacao
2 changes: 1 addition & 1 deletion .github/FUNDING.yaml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
github: [cumbucadev]
github: [cumbucadev]
22 changes: 22 additions & 0 deletions .github/workflows/pr.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: pr
on:
pull_request:
branches:
- main
permissions:
contents: write
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Setup Python
uses: actions/setup-python@v6
with:
python-version: 3.x
- name: Install MkDocs Material
run: pip install mkdocs-material pre-commit
- name: Lint MkDocs Configuration
run: mkdocs build --strict
- name: Validate Markdown Files
run: pre-commit run --all-files
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -230,4 +230,3 @@ pyrightconfig.json
# End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,macos,python

# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)

7 changes: 7 additions & 0 deletions .markdownlint-cli2.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"config": {
"MD013": false, // Disable line length rule,
"MD033": false, // Allow raw HTML in Markdown
"MD041": false // Allow multiple top-level headers in a file
}
}
15 changes: 15 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v6.0.0
hooks:
- id: check-added-large-files
- id: check-toml
- id: end-of-file-fixer
- id: trailing-whitespace

- repo: https://github.com/DavidAnson/markdownlint-cli2
rev: v0.20.0
hooks:
- id: markdownlint-cli2
files: ^docs/.*\.md$
args: ["--fix"]
2 changes: 1 addition & 1 deletion docs/assets/css/cumbuca.css
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
--md-primary-fg-color: #8B008B;
--md-primary-fg-color--light: #E4C8E4;
--md-primary-fg-color--dark: #8B008B;
}
}
124 changes: 124 additions & 0 deletions docs/codigo-de-conduta.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
# Código de Conduta de Colaboração

[English Version](https://github.com/cumbucadev/contributions/blob/main/CODE_OF_CONDUCT_EN.md)

## Nosso compromisso

Como participantes, colaboradoras e líderes, nós nos comprometemos a fazer com que a participação
em nossa comunidade seja uma experiência livre de assédio para todas as pessoas, independentemente
de idade, tamanho do corpo, deficiência aparente ou não aparente, etnia, características sexuais,
identidade ou expressão de gênero, nível de experiência, educação, situação sócio-econômica,
nacionalidade, aparência pessoal, raça, casta, religião ou identidade e orientação sexuais.

Comprometemo-nos a agir e interagir de maneiras que contribuam para uma comunidade aberta,
acolhedora, diversificada, inclusiva e saudável.

## Nossos padrões

Exemplos de comportamentos que contribuem para criar um ambiente positivo para a nossa comunidade
incluem:

* Demonstrar empatia e bondade com as outras pessoas
* Respeitar opiniões, pontos de vista e experiências contrárias
* Dar e receber feedbacks construtivos de maneira respeitosa
* Assumir responsabilidade, pedir desculpas às pessoas afetadas por nossos erros e aprender com a
experiência
* Focar no que é melhor não só para nós individualmente, mas para a comunidade em geral

Exemplos de comportamentos inaceitáveis incluem:

* Uso de linguagem ou imagens sexualizadas, bem como o assédio sexual ou de qualquer natureza
* Comentários insultuosos/depreciativos e ataques pessoais ou políticos (Trolling)
* Assédio público ou privado
* Publicar informações particulares de outras pessoas, como um endereço de e-mail ou endereço
físico, sem a permissão explícita delas
* Outras condutas que são normalmente consideradas inapropriadas em um ambiente profissional

## Aplicação das nossas responsabilidades

A liderança da comunidade é responsável por esclarecer e aplicar nossos padrões de comportamento
aceitáveis e tomará ações corretivas apropriadas e justas em resposta a qualquer comportamento que
considerar impróprio, ameaçador, ofensivo ou problemático.

A liderança da comunidade tem o direito e a responsabilidade de remover, editar ou rejeitar
comentários, commits, códigos, edições na wiki, erros e outras contribuições que não estão
alinhadas com este Código de Conduta e irá comunicar as razões por trás das decisões da moderação
quando for apropriado.

## Escopo

Este Código de Conduta se aplica dentro de todos os espaços da comunidade e também se aplica quando
uma pessoa estiver representando oficialmente a comunidade em espaços públicos. Exemplos de
representação da nossa comunidade incluem usar um endereço de e-mail oficial, postar em contas
oficiais de mídias sociais ou atuar como uma pessoa indicada como representante em um evento
online ou offline.

## Aplicação

Ocorrências de comportamentos abusivos, de assédio ou que sejam inaceitáveis por qualquer outro
motivo poderão ser reportadas para a liderança da comunidade, responsável pela aplicação, via
contato <cmaiacd@gmail.com> ou <mdeazevedomaia@gmail.com>. Todas as reclamações serão revisadas e
investigadas imediatamente e de maneira justa.

A liderança da comunidade tem a obrigação de respeitar a privacidade e a segurança de quem reportar
qualquer incidente.

## Diretrizes de aplicação

A liderança da comunidade seguirá estas Diretrizes de Impacto na Comunidade para determinar as
consequências de qualquer ação que considerar violadora deste Código de Conduta:

### 1. Ação Corretiva

**Impacto na comunidade**: Uso de linguagem imprópria ou outro comportamento considerado
anti-profissional ou repudiado pela comunidade.

**Consequência**: Aviso escrito e privado da liderança da comunidade, esclarecendo a natureza da
violação e com a explicação do motivo pelo qual o comportamento era impróprio. Um pedido de
desculpas público poderá ser solicitado.

### 2. Advertência

**Impacto na comunidade**: Violação por meio de um incidente único ou atitudes repetidas.

**Consequência**: Advertência com consequências para comportamento repetido. Não poderá haver
interações com as pessoas envolvidas, incluindo interações não solicitadas com as pessoas que
estiverem aplicando o Código de Conduta, por um período determinado. Isto inclui evitar interações
em espaços da comunidade, bem como canais externos como as mídias sociais. A violação destes termos
pode levar a um banimento temporário ou permanente.

### 3. Banimento Temporário

**Impacto na comunidade**: Violação grave dos padrões da comunidade, incluindo a persistência do
comportamento impróprio.

**Consequência**: Banimento temporário de qualquer tipo de interação ou comunicação pública com a
comunidade por um determinado período. Estarão proibidas as interações públicas ou privadas com as
pessoas envolvidas, incluindo interações não solicitadas com as pessoas que estiverem aplicando o
Código de Conduta. A violação destes termos pode resultar em um banimento permanente.

### 4. Banimento Permanente

**Impacto na comunidade**: Demonstrar um padrão na violação das normas da comunidade, incluindo a
persistência do comportamento impróprio, assédio a uma pessoa ou agressão ou depreciação a classes
de pessoas.

**Consequência**: Banimento permanente de qualquer tipo de interação pública dentro da comunidade.

## Atribuição

Este Código de Conduta é adaptado do [Contributor Covenant][homepage], versão 2.1, disponível em
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

As Diretrizes de Impacto na Comunidade foram inspiradas pela
[Aplicação do código de conduta Mozilla][Mozilla CoC].

Para obter respostas a perguntas comuns sobre este código de conduta, veja a página de Perguntas
Frequentes (FAQ) em [https://www.contributor-covenant.org/faq][FAQ]. Traduções estão disponíveis em
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
97 changes: 97 additions & 0 deletions docs/contribuindo/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# Como posso contribuir?

Antes de tudo, obrigada pelo interesse em contribuir com a [cumbuca.dev](https://cumbuca.dev)!

Antes de começar, é importante ler o nosso [Código de Conduta](../codigo-de-conduta.md) para entender as diretrizes de comportamento e colaboração dentro da comunidade.

Vamos focar em como você pode ajudar a melhorar a documentação da [cumbuca.dev](https://cumbuca.dev), mas sinta-se à vontade para explorar outras formas e projetos de contribuir!

Vamos lá!

## :material-github: O que é Git e GitHub?

Se você ainda não teve contato com Git e GitHub, sugerimos que você visite nosso repositório [GitCaos🔥](https://github.com/cumbucadev/gitcaos)! Lá temos uma explicação de conceitos base, além de guiar vocês para realizar seu primeiro commit!

Quaisquer dúvidas, pode abrir uma issue lá mesmo!

## :question: O que preciso para contribuir?

Antes de começar a contribuir, você vai precisar de:

- `Python >= 3.13` (Possivelmente já vem instalado no seu computador)
- `pip` (gerenciador de pacotes do Python, geralmente já vem com o Python)
- `poetry` (gerenciador de dependências e ambientes virtuais para Python, mais informações em [https://python-poetry.org/docs/](https://python-poetry.org/docs/#installation))

A documentação da [cumbuca.dev](https://cumbuca.dev) está [hospedada neste repositório](https://github.com/cumbucadev/docs), que é construído com [MkDocs](https://www.mkdocs.org/) e o tema [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).

Basta forkar o repositório e cloná-lo localmente com o comando:

```bash
git clone {url_do_seu_fork}
```

Uma vez clonado, navegue até a pasta do repositório:

```bash
cd /pasta/do/repositorio
```

Agora, instale as dependências do projeto usando o Poetry:

```bash
poetry install && pre-commit install
```

Crie uma branch para suas alterações:

```bash
git checkout -b minha-nova-branch
```

## :book: Estrutura da Documentação

A documentação está organizada na pasta `docs/`. Cada arquivo Markdown (`.md`) representa uma página ou seção do site. A estrutura de navegação do site é definida no arquivo `mkdocs.yaml`, onde você pode ver como as páginas estão organizadas.

## :memo: Criando e editando a documentação

Os arquivos da documentação estão na pasta `docs/`. Você pode editar os arquivos Markdown (`.md`) diretamente nessa pasta. Caso precise saber mais sobre a sintaxe Markdown, consulte este [guia rápido](https://www.markdownguide.org/cheat-sheet/).

Depois de fazer suas alterações, você tem que adicionar seu arquivo no `mkdocs.yaml` para que ele apareça na navegação do site. Veja como fazer isso no exemplo abaixo:

```yaml
nav:
- Página inicial: index.md
- Código de Conduta: codigo-de-conduta.md
- Como contribuir:
- contribuindo/index.md
- contribuindo/meu_novo_arquivo.md # <- Adicione seu arquivo aqui, ou onde fizer sentido
```

Uma vez feito isso você pode visualizar as mudanças localmente rodando o comando:

```bash
mkdocs serve
```

Agora basta acessar `http://localhost:8000` no seu navegador para ver as mudanças!

## :twisted_rightwards_arrows: Enviando suas contribuições

Depois de fazer suas alterações e verificar que tudo está funcionando corretamente, você pode enviar suas contribuições de volta para o repositório oficial da [cumbuca.dev](https://cumbuca.dev) seguindo estes passos:

1. Faça um commit (ou vários!) com uma mensagem clara e descritiva do que foi alterado:

```bash
git add arquivos/modificados
git commit -m "Descrição clara do que foi alterado"
```

O `pre-commit` irá executar, corrigindo e te avisando sobre possíveis problemas antes de permitir o commit. Caso algo seja apontado, corrija os problemas indicados, adicione os arquivos novamente e tente fazer o commit novamente.

1. Envie suas alterações para o seu fork no GitHub:

```bash
git push origin minha-nova-branch
```

1. Vá até o repositório oficial da [cumbuca.dev](https://github.com/cumbucadev/docs) e abra um Pull Request com suas alterações. Descreva claramente o que foi alterado e por quê.
60 changes: 60 additions & 0 deletions docs/contribuindo/templates/template-ata-reuniao.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Template de Ata de Reunião

Template para registro de atas de reuniões dos núcleos da Cumbuca Dev.

## Código Markdown

```markdown
# 📝 Reunião — {DATA}

## 👥 Pessoas Presentes
- @{handle}
- @{handle}

---

## 📋 Pauta
- {tópico 1}
- {tópico 2}
- {tópico 3}

---

## 🧠 Discussões
- {Resumo do que foi debatido}
- {Resumo do que foi debatido}

---

## ✅ Decisões
- {Decisão importante tomada}
- {Decisão importante tomada}

---

## 🚀 Próximos Passos

| Ação | Responsável | Prazo |
|------|-------------|-------|
| {ação} | @{handle} | {data} |
| {ação} | @{handle} | {data} |

---

## 🔄 Pendências
- {pendência}
- {pendência}

---

## 🔗 Links Importantes
- Issue(s) relacionada(s): {link}
- PR(s): {link}
- Materiais: {link}
- Gravação do Encontro: {link}

---

## 🗒 Observações
{informações adicionais que não se encaixam nas seções acima}
```
Loading