Como ajudar

Ajude com issues, revisão de texto, traduções, testes de modelos e pull requests.

Pepe é um projeto novo. Ajuda pequena e focada já faz diferença: abrir uma issue clara, responder dúvidas, revisar textos, testar provedores, melhorar traduções ou enviar um PR.

Formas úteis de ajudar

Do fork ao PR

  1. Faça um fork no GitHub.
  2. Clone seu fork:
git clone git@github.com:SEU_USUARIO/pepe.git
cd pepe
  1. Adicione o repositório original como upstream:
git remote add upstream https://github.com/pepe-agent/pepe.git
git fetch upstream
  1. Crie uma branch a partir da principal:
git checkout -b docs-melhora-quickstart upstream/master
  1. Instale dependências e rode os testes:
mix deps.get
mix test
  1. Se for mexer no website:
cd website
npm install
npm run dev
  1. Faça a mudança. Para docs e textos, revise também os outros idiomas quando a mesma página existir neles.

  2. Rode a checagem final na raiz do projeto:

mix precommit
  1. Faça commit e envie para o seu fork:
git add .
git commit -m "Improve quickstart copy"
git push origin docs-melhora-quickstart
  1. Abra um pull request contra pepe-agent/pepe:master. Explique o que mudou, por que mudou e linke a issue, se houver.

Bons PRs

Um bom PR é pequeno, tem escopo claro e deixa fácil entender a decisão. Para código, inclua teste quando mudar comportamento. Para documentação, prefira frases curtas, exemplos reais e links para páginas mais detalhadas em vez de repetir tudo.

Ajuda com modelos

Relatos de provedores são muito úteis. O relatório ideal inclui:

Se algo falhar, abra uma issue com esse contexto. Mesmo um “testei e funcionou” ajuda a saber quais integrações estão saudáveis.