Burimo é uma ferramenta que ajuda a corrigir termos que podem ser pejorativos ou ofensivos, especialmente para pessoas negras. A ideia é conscientizar as pessoas para usarem palavras que não carreguem racismo ou preconceito.
Muita gente usa certas palavras no dia a dia sem saber que elas podem ser ofensivas. O Burimo está aqui para mudar isso, sugerindo alternativas que fazem mais sentido e são respeitosas, ajudando a melhorar a forma como nos comunicamos. Além de corrigir, você também aprende e faz parte da mudança para um mundo mais inclusivo.
O grande diferencial do Burimo.io é a sua capacidade de não apenas apontar erros, mas de educar. Ele transforma cada correção em uma oportunidade de aprendizado, permitindo que as pessoas reflitam sobre suas palavras e atitudes, e se tornem mais empáticas no seu dia a dia.
Em resumo, o Burimo vai além de ser uma ferramenta de correção. Ele atua como um agente de mudança, ajudando a moldar uma sociedade onde a linguagem seja usada para unir, não para ferir.
Descreva a estrutura de diretórios e arquivos do projeto. Isso ajuda novos desenvolvedores a entender a organização do código.
burimo.io/
│
├── css/
│ └── style.css
│
├── templates/
│ ├── footer.html
│ └── header.html
│
├── javascript/
│ ├── getContentFooterTemplate.js
│ └── getContentHeaderTemplate.js
│
├── requirements.txt
├── README.md
└── home.html
Explique como rodar os testes do projeto. Se for necessário algum comando específico, descreva-o aqui.
pytest tests/Informe como outros desenvolvedores podem contribuir para o projeto. Forneça diretrizes sobre como reportar bugs, submeter melhorias ou abrir pull requests.
- Faça um fork do projeto.
- Crie um branch para a sua funcionalidade (
git checkout -b minha-nova-funcionalidade). - Commit suas mudanças (
git commit -m 'Adicionar minha nova funcionalidade'). - Faça o push para o branch (
git push origin minha-nova-funcionalidade). - Abra um pull request.
Inclua a licença do projeto. Por exemplo:
Este projeto está licenciado sob a MIT License.
Liste os autores do projeto. Se for um projeto de código aberto, você pode adicionar uma seção de "Contribuidores".
- Seu Nome - Desenvolvedor - Seu GitHub
Essa estrutura cobre os principais tópicos de um README.md bem documentado, facilitando a compreensão e contribuição ao projeto. Você pode adicionar ou remover seções conforme necessário.