Então você quer contribuir com a BookWyrm? Show! Se houver algum problema aberto no repositório que você quer consertar, deixer um comentário para que o trabalho não seja feito mais de uma vez. Tente manter o escopo dos pull requests pequenos e focados em uma única questão. Assim é mais fácil revisar, e se alguma parte precisar ser alterada, isso não atrapalhará as outras partes.
Se você não sabe exatamente como consertar alguma coisa, ou se não consegue fazê-lo, está tudo bem! Só deixe um comentário no pull request e vamos descobrir 💖.
Os pull requests passam por todas as verificações automáticas antes de serem mesclados - isso inclui verificações de estilos, linters globais, uma verificação de segurança e testes unitários.
There are several ./bw-dev commands you may find helpful for linting and testing prior to pushing your pull request. See Command Line Tool for all the options available.
Usamos o EditorConfig para manter uma identação e fins de linha consistentes.
BookWyrm uses ruff for both code linting (checking for errors) and formatting (ensuring code style is consistent). All new pull requests are checked with GitHub actions, and you can automatically fix code style problems by running ./bw-dev ruff. For linting errors, you can try ./bw-dev ruff-fix to automatically fix errors, though this may not always be possible.
Ruff linting warnings must be addressed before pull requests are merged, but it's a judgement call if the suggestion should be used, or the warning suppressed. See the Ruff projects's documentation on suppressing warnings using code comments.
The BookWyrm project previously used Black for formatting and Pylint for linting. You may notice artefacts such as pylint suppression comments in older code. We are still refining our linting rules so if something seems confusing or not quite right, don't hesitate to ask for advice.
We are gradually rolling out static type checking across the BookWyrm code base. This is a long term project. Whilst it is not compulsory to formally define types in new code, it is strongly recommended. This will help to avoid some more subtle bugs that may not be identified in tests.
We currently use mypy as our static type checker. Find out more about how to use mypy at the mypy project documentation.
Suas pull requests também vão ser verificadas pelo linter curlylint dos templates do Django.
Usamos o stylelint para conferir todas as regras de CSS. Como no Pylint, você pode disativar o stylelint para alguma regra particular, mas você vai precisar de uma boa justificativa para fazê-lo.
ESLint verifica todas as modificações em JavaScript que você fizer. Se o ESLint não gostar do seu JavaScript, dê uma olhada na mensagem do linter para ver qual é o problema.
A BookWyrm quer ser o mais inclusiva e acessível possível.
Quando for contribuir com código, dê uma olhada na Check list de web design inclusivo antes de enviar o pull request. Para sugestões de acessibilidade, o A11Y-101 também é uma fonte útil. For information on how to make your page templates multi-lingual, see the Translations section.
Algumas coisas que colaboradores da BookWyrm acharam boas de se lembrar:
input[type="checkbox"] ou input[type="radio"] dentro <label><label>, o <label> deve ser colocado depois do elemento ao que ele está relacionado<button> para tudo que sirva para disparar uma ação de JavaScript (ex: esconder ou mostrar um formulário) ou enviar uma solicitação POST (ex: enviar um formulário)<a> para tudo que faça uma solicitação GET. Normalmente um elemento de âncora (<a>) não costuma ser estilizado como um botão (class="button"), mas há algumas exceções, como os botões de "Cancelar". Se tiver alguma dúvida, peça sugestões no seu pull requestBookWyrm is an international project and aims to be inclusive of as many languages as possible. All user-facing messages and templates should follow the advice on translations and gendered language.