Writing a good patch

Write separate changes

It is annoying when you get a massive patch that is said to fix 11 odd problems, but discussions and opinions do not agree with 10 of them or 9 of them were already fixed differently. Then the person merging this change needs to extract the single interesting patch from somewhere within the massive pile of sources, and that creates a lot of extra work.

Preferably, each fix that addresses an issue should be in its own patch/commit with its own description/commit message stating exactly what they correct so that all changes can be selectively applied by the maintainer or other interested parties.

Furthermore, separate changes enable bisecting much better for tracking issues and regression in the future.

Documentação

Documentation can be a tedious task; however, it is necessary for someone to complete it. It makes things a lot easier if you submit the documentation together with code changes. Please remember to document methods, complex code blocks, or user-visible features.

Ver também

Contribuir com a documentação do Weblate

Test cases

The tests allow us to quickly verify that the features are working as they are supposed to. To maintain this situation and improve it, all new features and functions that are added need to be tested in the test suite. Every feature that is added should get at least one valid test case that verifies that it works as documented.

Ver também

Conjunto de testes e integração contínua do Weblate

Mensagens de commit

Os commits do Git devem seguir a especificação de Conventional Commits.

Padrão de codificação e linting do código

O código deve seguir as diretrizes de codificação PEP 8 e deve ser formatado usando o formatador de código ruff.

Qualquer novo código deve utilizar dicas de tipo PEP 484. Ainda não estamos verificando isso em nosso CI, pois o código existente ainda não os inclui.

Para verificar a qualidade do código, você pode usar ruff e sua configuração é armazenada em pyproject.toml.

A abordagem mais fácil para impor tudo isso é instalar pre-commit. O repositório contém a configuração para verificar se os arquivos do commit estão sãos. Depois de instalá-lo (ele já está incluído no pyproject.toml), ative-o executando pré-commit install na sua cópia do Weblate. Desta forma, todas as suas alterações serão verificadas automaticamente.

Você também pode acionar a verificação manualmente, para verificar todos os arquivos executados:

pre-commit run --all

Coding securely

Qualquer código para Weblate deve ser escrito com Princípios de Segurança por Design (inglês) em mente.

AI guidelines

When contributing content to the project, you give us permission to use it as-is, and you must make sure you are allowed to distribute it to us. By submitting a change to us, you agree that the changes can and should be adopted by the project and get redistributed under the project license. Authors should be explicitly aware that the burden is on them to ensure no unlicensed code is submitted to the project.

This is independent of whether AI is used or not.

When contributing a pull request, you should, of course, always make sure that the proposal is of good quality and the best effort that follows our guidelines. A basic rule of thumb is that if someone can spot that the contribution was made with the help of AI, you have more work to do.

We can accept code written with the help of AI into the project, but the code must still follow coding standards, be written clearly, be documented, feature test cases, and adhere to all the normal requirements we have.