.gitignore
Esta es la colección de Github de plantillas de archivos .gitignore
. Utilizamos esta lista para completar los sellos de plantilla .gitignore
disponibles en la interfaz Github.com al crear nuevos repositorios y archivos.
Para obtener más información sobre cómo funcionan los archivos .gitignore
y cómo usarlos, los siguientes recursos son un excelente lugar para comenzar:
Apoyamos una colección de plantillas, organizadas de esta manera:
Global
contiene plantillas para varios editores, herramientas y sistemas operativos que pueden usarse en diferentes situaciones. Se recomienda que las agregue a su plantilla global o fusione estas reglas en sus plantillas específicas de proyecto si desea usarlas de forma permanente.community
contiene plantillas especializadas para otros idiomas, herramientas y proyectos populares, que actualmente no pertenecen a las plantillas convencionales. Estos deben agregarse a las plantillas específicas de su proyecto cuando decida adoptar el marco o la herramienta. Una plantilla debe contener un conjunto de reglas para ayudar a los repositorios de GIT a funcionar con un lenguaje de programación, marco, herramienta o entorno específicos.
Si no es posible curar un pequeño conjunto de reglas útiles para esta situación, entonces la plantilla no es una buena opción para esta colección.
Si una plantilla es principalmente una lista de archivos instalados por una versión particular de algún software (por ejemplo, un marco PHP), podría vivir bajo el directorio community
. Ver plantillas versionadas para más detalles.
Si tiene un pequeño conjunto de reglas, o desea apoyar una tecnología que no esté ampliamente en uso, y aún así cree que esto será útil para otros, lea la sección sobre plantillas especializadas para obtener más detalles.
Incluya detalles al abrir la solicitud de extracción si la plantilla es importante y visible. Es posible que no lo aceptemos de inmediato, pero podemos promoverlo a la raíz en una fecha posterior basada en intereses.
También comprenda que no podemos enumerar todas las herramientas que alguna vez existieron. Nuestro objetivo es curar una colección de las plantillas más comunes y útiles , no asegurarnos de que cubramos todos los proyectos posibles. Si elegimos no incluir su idioma, herramienta o proyecto, no es porque no sea increíble.
Nos encantaría que nos ayude a mejorar este proyecto. Para ayudarnos a mantener esta colección de alta calidad, solicitamos que las contribuciones se adhieran a las siguientes pautas.
Proporcione un enlace a la aplicación o la página de inicio del proyecto . A menos que sea extremadamente popular, existe la posibilidad de que los mantenedores no conozcan o usen el idioma, el marco, el editor, la aplicación o el proyecto al que se aplique su cambio.
Proporcione enlaces a la documentación que respalde el cambio que está haciendo. La documentación canónica actual que menciona los archivos que se ignoran es mejor. Si la documentación no está disponible para admitir su cambio, haga lo mejor que pueda para explicar para qué sirven los archivos que se están ignorando.
Explica por qué estás haciendo un cambio . Incluso si parece evidente, tome una oración o dos para decirnos por qué su cambio o adición debería ocurrir. Es especialmente útil articular por qué este cambio se aplica a todos los que trabajan con la tecnología aplicable, en lugar de solo usted o su equipo.
Considere el alcance de su cambio . Si su cambio es específico para un cierto idioma o marco, asegúrese de que el cambio se realice a la plantilla para ese idioma o marco, en lugar de la plantilla de un editor, herramienta o sistema operativo.
Solo modifique una plantilla por solicitud de extracción . Esto ayuda a mantener las solicitudes de extracción y los comentarios centrados en un proyecto o tecnología específica.
En general, cuanto más pueda hacer para ayudarnos a comprender el cambio que está haciendo, más probabilidades tendremos de aceptar su contribución rápidamente.
Algunas plantillas pueden cambiar mucho entre las versiones, y si desea contribuir a este repositorio, debemos seguir este flujo específico:
community/
Esto ayuda a garantizar que los usuarios obtengan la última versión (porque usarán lo que sea en la raíz), pero ayuda a los mantenedores a admitir versiones más antiguas aún en la naturaleza.
Si tiene una plantilla que le gustaría contribuir, pero no es muy convencional, considere agregar esto al directorio community
en una carpeta que mejor se adapte a donde pertenece.
Las reglas en su plantilla especializada deben ser específicas para el marco o la herramienta, y cualquier plantilla adicional debe mencionarse en un comentario en el encabezado de la plantilla.
Por ejemplo, esta plantilla puede vivir en community/DotNet/InforCRM.gitignore
:
# gitignore template for InforCRM (formerly SalesLogix)
# website: https://www.infor.com/product-summary/cx/infor-crm/
#
# Recommended: VisualStudio.gitignore
# Ignore model files that are auto-generated
ModelIndex.xml
ExportedFiles.xml
# Ignore deployment files
[Mm]odel/[Dd]eployment
# Force include portal SupportFiles
!Model/Portal/*/SupportFiles/[Bb]in/
!Model/Portal/PortalTemplates/*/SupportFiles/[Bb]in
Así es como le sugerimos que proponga un cambio en este proyecto:
main
.El uso de la interfaz basada en la web para hacer cambios también está bien, y lo ayudará a bifurcarse automáticamente el proyecto y solicitar que envíe una solicitud de extracción también.
CC0-1.0.