Diretrizes de Contribuição

Aviso

This documentation refers to an outdated SpongeAPI version and is no longer actively maintained. While the code examples still work for that API version, the policies, guidelines, and some links may have changed. Please refer to the latest version of the documentation for those.

Vamos precisar sempre de programadores para nos ajudar a melhorar a Sponge Api. Não há nenhum projeto perfeito, há sempre coisas que podem ser melhoradas. Se és um programador e estás interessado, não exites. Tem apenas o cuidado de seguir as diretrizes.

Nota

Developers who show determination and consistency in their contributions to the project may be invited to join the Sponge Staff by Team Leaders, at their discretion. There is no formal application process. Please don’t ask to be staff, we’ll ask you.

Passos Gerais

  1. Prepara o teu espaço de trabalho conforme descrito em Preparação para Desenvolvimento.
  2. Certifica-te de que estás familiarizado com o Git e com o GitHub. Se precisas de refrescar os teus conhecimentos, dá uma olhadela aqui: Como Git(Hub)
  3. Procura problemas existentes na SpongeAPI <https://github.com/SpongePowered/SpongeAPI/issues>, no SpongeCommon, no`SpongeForge <https://github.com/SpongePowered/SpongeForge>`_, SpongeVanilla, e nos`SpongeDocs <https://github.com/SpongePowered/SpongeDocs>`_. Pode haver alguém que já esteja a trabalhar nesse mesmo problema. Poderás também também verificar os problemas marcados com «help wanted» <https://github.com/SpongePowered/SpongeAPI/labels/help%20wanted> para problemas que possam precisar ajuda.

Nota

Por favor não submetas Pull Requests para modificações com menos de 20 linhas. Em vez disso, entra no canal de IRC #sponge (irc.esper.net) ou #spongedev (rc.esper.net) para nós fazermos uma única alteração com todas as sugestões pequenas que recebermos.

  1. Se o problema necessitar uma grande alteração, deverás submeter o problema sem nenhuma alteração inicialmente para nós confirmarmos o problema e sabermos que estás a trabalhar em arranjá-lo. Também deverás criar um WIP (trabalho em andamento) pull request com «[WIP]» no início do título para começarmos a revê-lo o mais cedo possível.
  2. Faz fork do projeto, clona-o e faz as alterações num novo branch.
  3. Testa as tuas alterações (verifica que compila). Depois faz commit e push para o teu fork.
  4. Envia o pull request com uma pequena descrição do que é que alteraraste e porquê que deve ser alterado dessa maneira.
  5. Se fizeres novas alterações, envia novos commits para o teu branch. Não juntes as alterações, isso faz com que seja extremamente difícil de ver o que mudaste comparando à versão anterior do teu pull request.
  6. Make sure your PR is rebased to the latest changes of the branch you’re intending to merge it into. If you need help rebasing it, just ask!

Dica

If you’re unsure which branch you should base your work on, read about our Versioning System and Repository Branch Layout before submitting your PR.