Consertos e entregas

Enviando consertos

Nas primeiras vezes que você realizar alterações no manual, você deverá enviá-las em formato de «patches» (ou enviando o arquivo inteiro, ou um arquivo diferencial) para o administrador da seção para revisão. Isto é feito para garantir que manteremos um manual do usuário com a mais alta qualidade, e que você não quebre acidentalmente qualquer coisa vital antes de estar acostumado com o sistema de trabalho.

De maneira a enviar um conserto, siga este processo:

  1. Faça quaisquer das alterações que desejar.

  2. Crie um arquivo de conserto executando:

    svn diff > filename.diff

    Isto criará um arquivo de texto simples que mostra quais textos foram adicionados, removidos ou alterados entre seus arquivos de trabalho e o repositório central.

    Caso você tenha criado ou apagado arquivos, você deverá executar svn add /caminho/do/arquivo ou svn rm /caminho/do/arquivo antes de criar o arquivo diferencial (diff). Para ver uma lista de arquivos afetados, execute svn status.

  3. Envie (faça o upload) do arquivo aqui. Caso você já não tenha uma conta, você pode registrar-se para criar uma aqui.

  4. Após a submissão do arquivo diferencial (diff), você será requisitado a «Criar uma nova revisão», antes que você adicione um título e uma descrição de suas mudanças.

  5. Por favor, verifique se o projeto de documentação está atribuído no campos de tags, de maneira que você possa notificar a equipe responsável sobre seus consertos. Você pode também contactar a equipe através da lista de e-mail ou Bate-papo Blender.

  6. They will review your patch and let you know about any changes you could make. If there is no issue, your patch will be accepted and then committed by the team of your patch.

Nota

Caso os seus consertos incluam alterações para alguns locais ou imagens adicionais, simplesmente anexe-os quando você estiver criando a revisão.

Consertos (patches) necessários e construtivos são propensos a ser aceitos muito rapidamente. Uma vez que você tenha se acostumado a fazer alterações e não necessitar mais de retornos informativos (feedbacks), não haverá mais necessidade de uma pessoa que faça esse intermédio e então, será possível fornecer a você o acesso direto para editar o manual.

Veja também

See Release Cycle for documentation on how to make commits to a specific release branch and how to create merge commits.

Entrega direta

Once you are provided with the direct access to edit the manual, you can start committing directly instead of creating a patch file. Doing this will submit the change directly to our central repository.

Tudo o que você precisa fazer é executar:

svn commit -m "This is what I did"

Caso você queira deixar uma mensagem usando -m "mensagem", você será requisitado a digitar a mensagem em um editor de textos.

Não se esqueça de executar sempre uma atualização local usando svn update antes das entregas.

Then you will be asked for your username and password (from developer.blender.org) before the change is committed.

Nota

Make sure to use your username (case sensitive) and not your email.

Seus arquivos modificados são entregues via «upload» para o repositório central para que outros possam trabalhar com ele e continuar colaborando. As entregas são rastreadas dentro dos repositórios de Difusão. Logo após um breve período, suas alterações se tornarão visíveis dentro do manual online.

Writing a Good Commit Message

When making changes to the manual that directly relate to a specific commit (change) in Blender, it is helpful to make the title of the commit the same as the commit made to Blender. It is requested that you include the commit hash of the commit made to the Blender source code.

For example, the commit rBM8473 includes a descriptive indicative of the changes made along with the hash rBa71d2b260170. The hash can be extracted from the URL provided in the Documentation task for a specific upcoming release.

Other more general changes do not have to follow the above policy however, it is still important to make the description clear about what changes you made and why. It can be helpful to prefix the commit title with a prefix word such as Cleanup: or Fix: when you are making general cleanups or fixes respectively.

Writing good commit messages helps administrators keep track of changes made and ensures all new features are properly documented.