Presentando una Solicitud de Extracción

Advertencia

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.

Los Basicos

Primero debes configurar tu máquina para poder desarrollar para y con Sponge:

Cuando hayas terminado y sientas que estás listo para el desarrollo de Sponge, decide en qué partes quieres trabajar.

Escribiendo un PR

Corrigiendo Errores

Explica en pocas palabras:

  • que error encontraste, especialmente

    • como se comportó

    • como crees que debería comportarse

  • que arreglaste

  • como lo arreglaste

Adiciones Mayores de API

Entonces, has desarrollado una adición de API bastante grande que quieres presentar ahora como un PR. ¡Bien! Los PRs constructivos son lo que hacen a este proyecto cada vez mejor. Lo que nos lleva a escribir la gloriosa Descripción de PR.

Han habido unos cuantos en el pasado que van más allá de los estándares, algunos ejemplos son:

Por supuesto, esos ejemplos son el extremo, pero los PRs que son aceptados y proveídos como un buen estándar de lo que debería ser incluido en una descripción PR son:

Algunas cosas que pueden ser tenidas en cuenta de esto:

  • Los enlaces a cualquier implementación de PRs deben ser en forma de comentarios al principio del PR, esto se puede lograr con el Markdown de GitHub

*SpongeAPI*|[SpongeCommon](html link)|[SpongeForge](html link)|[SpongeVanilla](html link)

  • Descripciones en comentarios de los que la API PR pretende hacer, esto puede ser un resumen breve como si se escribiera en ensayo, cuando mucho de 4 frases de largo, dependiendo de cual sea la funcionalidad.

  • Ejemplos de código en comentarios de como las extensiones pueden usar la nueva característica (y si hay características viejas existentes, el porque necesitaban ser cambiadas).