Guias 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.

Sempre haverá demanda de desenvolvedores para nos ajudar a melhorar a SpongeApi. Não existe isso de projeto perfeito, sempre há coisas que podem ser melhoradas. Se você é um desenvolvedor e está interessado em ajudar então por favor, não hesite. Apenas certifique-se de seguir nossas 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. Prepare sua workspace como descrito em Preparando-se para o desenvolvimento.
  2. Certifique-se de estar familiarizado com o Git e com o GitHub. Se precisa refrescar seu conhecimento, dê uma olhada aqui: Como utilizar o Git(Hub)
  3. Verifique se há problemas existentes nos repositórios SpongeAPI, SpongeCommon, SpongeForge, SpongeVanilla, e SpongeDocs. Existe a possibilidade de mais alguém estar trabalhando na mesma coisa. Você também pode checar problemas marcados com “procura-se ajuda” para problemas que precisamos da sua ajuda.

Nota

Por favor, não envie pull request para mudanças com menos de 20 linhas. Em vez disso, entre em #sponge no IRC (irc.esper.net) ou em #spongedev no IRC (irc.esper.net) e iremos alterar junto com outras mudanças pequenas.

  1. Se o problema requer uma grande mudança você pode querer enviar os problemas sem as mudanças necessárias primeiro para que possamos confirmar o problema e saber que você está trabalhando para resolver ele. Você também deve antes criar um WIP (work in progress) pull request com o prefixo [WIP] para que possamos começar a rever eles.
  2. fork no projeto, clone ele e faça suas alterações em um branch extra.
  3. Teste suas alterações (certifique-se de que compila!), comite e envie elas ao seu fork.
  4. Envie o pull request com um pequeno sumário do que você mudou e por que deve ser alterado dessa forma.
  5. Se você fizer mudanças adicionais, envie novos commits ao seu branch. Não misture suas mudanças, isso faz com que ver o que você mudou comparado à versão anterior do seu pull request fique algo extremamente difícil.
  6. Certifique-se de que seu PR está com base nas últimas mudanças do branch em que você está interessado em fazer o merge. Se você precisa fazer rebase, apenas peça!

Dica

Se você não estiver seguro sobre qual branch você deve basear seu trabalho, leia sobre nosso Versioning System and Repository Branch Layout antes de enviar sua PR.