🤝 Guía de Contribución - AmoxcalliDev

¡Gracias por tu interés en contribuir a AmoxcalliDev! 🎉

Esta guía te ayudará a entender cómo puedes colaborar en nuestros proyectos Open Source.

📋 Tabla de Contenidos

Código de Conducta
Uso en Otros Repositorios
¿Cómo Puedo Contribuir?
Proceso de Contribución
Estándares de Código
Commits y Pull Requests
Reportar Bugs
Sugerir Mejoras

📜 Código de Conducta

Este proyecto se rige por nuestro Código de Conducta. Al participar, se espera que respetes estos lineamientos.

🔗 Uso en Otros Repositorios

Esta guía de contribución aplica para todos los repositorios de AmoxcalliDev. Si estás creando un nuevo repositorio o actualizando uno existente, debes hacer referencia a estos archivos centralizados.

Para Repositorios Nuevos

Al crear un nuevo repositorio, agrega un archivo CONTRIBUTING.md en la raíz con el siguiente contenido:

# Guía de Contribución

Este proyecto sigue la [Guía de Contribución de AmoxcalliDev](https://github.com/AmoxcalliDev/.github/blob/main/CONTRIBUTING.md).

Por favor, lee las guías completas antes de contribuir.

## Enlaces Importantes

- [Guía de Contribución](https://github.com/AmoxcalliDev/.github/blob/main/CONTRIBUTING.md)
- [Código de Conducta](https://github.com/AmoxcalliDev/.github/blob/main/CODE_OF_CONDUCT.md)

Para Repositorios Existentes

Si ya tienes un repositorio con su propio CONTRIBUTING.md, actualízalo para hacer referencia a estas guías:

# Guía de Contribución

Este proyecto sigue la [Guía de Contribución de AmoxcalliDev](https://github.com/AmoxcalliDev/.github/blob/main/CONTRIBUTING.md).

## Guías Específicas de Este Proyecto

[Aquí puedes agregar guías específicas del repositorio si es necesario]

## Guías Generales

Para conocer las guías completas de contribución de AmoxcalliDev, visita:
- [Guía de Contribución](https://github.com/AmoxcalliDev/.github/blob/main/CONTRIBUTING.md)
- [Código de Conducta](https://github.com/AmoxcalliDev/.github/blob/main/CODE_OF_CONDUCT.md)

Ventaja de Este Enfoque

✅ Consistencia: Todos los proyectos siguen las mismas reglas

✅ Mantenimiento fácil: Actualizas un solo archivo y aplica para todos

✅ Claridad: Los contribuidores saben qué esperar en cualquier repo

✅ Automático: Si un repo no tiene CONTRIBUTING.md, GitHub usa automáticamente el de .github

💡 Nota: GitHub automáticamente usa los archivos de este repositorio .github como predeterminados para todos los repos de la organización que no tengan sus propios archivos.

🚀 ¿Cómo Puedo Contribuir?

Hay muchas formas de contribuir a AmoxcalliDev:

💻 Contribuciones de Código

Arreglar bugs reportados en los issues
Implementar nuevas features
Mejorar la documentación
Refactorizar código existente
Agregar o mejorar tests

📝 Contribuciones sin Código

Reportar bugs
Sugerir nuevas features
Mejorar la documentación
Responder preguntas en Discussions
Revisar Pull Requests de otros colaboradores
Compartir el proyecto en redes sociales

🔄 Proceso de Contribución

1️⃣ Fork y Clone

# Haz fork del repositorio desde GitHub
# Luego clona tu fork
git clone https://github.com/TU_USUARIO/NOMBRE_DEL_REPO.git
cd NOMBRE_DEL_REPO

# Agrega el repositorio original como upstream
git remote add upstream https://github.com/AmoxcalliDev/NOMBRE_DEL_REPO.git

2️⃣ Crea una Rama

Crea una rama descriptiva para tu trabajo:

# Para nuevas funcionalidades
git checkout -b feature/nombre-descriptivo

# Para arreglar bugs
git checkout -b fix/descripcion-del-bug

# Para documentación
git checkout -b docs/que-documentas

3️⃣ Haz tus Cambios

Escribe código limpio y legible
Sigue las convenciones del proyecto
Agrega comentarios cuando sea necesario
Asegúrate de que el código funcione correctamente

4️⃣ Prueba tus Cambios

Antes de hacer commit, asegúrate de que:

El código compile/ejecute sin errores
Los tests existentes pasen
Hayas agregado tests para tu nuevo código (si aplica)
La documentación esté actualizada

5️⃣ Commit

Usa mensajes de commit descriptivos en español o inglés (lo que prefieras):

# En español
git add .
git commit -m "feat: agrega funcionalidad de autenticación"

# En inglés
git add .
git commit -m "feat: add authentication functionality"

Tipos de Commits

Usamos Conventional Commits:

feat: Nueva funcionalidad / New feature
fix: Corrección de bug / Bug fix
docs: Cambios en documentación / Documentation changes
style: Formateo, puntos y comas faltantes, etc. / Formatting, missing semicolons, etc.
refactor: Refactorización de código / Code refactoring
test: Agregar o modificar tests / Add or modify tests
chore: Tareas de mantenimiento / Maintenance tasks

Ejemplos en español:

feat: agrega endpoint para obtener usuarios
fix: corrige error en validación de email
docs: actualiza README con instrucciones de instalación
refactor: optimiza consulta de base de datos
test: agrega tests para módulo de pagos

Ejemplos en inglés:

feat: add endpoint to get users
fix: correct email validation error
docs: update README with installation instructions
refactor: optimize database query
test: add tests for payment module

6️⃣ Push y Pull Request

# Haz push a tu fork
git push origin tu-rama

# Crea un Pull Request desde GitHub

Cuando crees tu PR, automáticamente se cargará nuestro template. Asegúrate de completar toda la información relevante:

Descripción clara de los cambios
Tipo de cambio (bug fix, feature, docs, etc.)
Issue relacionado (si aplica)
Cómo probaste los cambios
Checklist de revisión

💡 Tip: Revisa el template completo en pull_request_template.md

💅 Estándares de Código

General

Idioma: Código y variables en inglés (estándar global), comentarios y documentación pueden ser en español o inglés
Consistencia de idioma: Elige un idioma (español o inglés) y manténlo en todo el archivo/módulo. Evita mezclar idiomas (espanglish) ya que dificulta la lectura
Estilo de código: Sigue las convenciones y buenas prácticas del proyecto al que contribuyas (indentación, formato, estructura)
Nombres: Descriptivos y significativos

💡 Nota sobre idiomas: Seguimos los estándares globales usando inglés para nombres de variables, funciones y clases. Los comentarios, documentación y wikis pueden estar en español. Si dominas el inglés, puedes contribuir con traducciones.

⚠️ Evita el espanglish: Si comentas en español, hazlo todo en español. Si comentas en inglés, hazlo todo en inglés. La mezcla confunde a nuevos contribuidores.

JavaScript/TypeScript

// ✅ Bueno - Todo en inglés
const getUserById = async (userId) => {
  // Find user in database
  const user = await db.users.findById(userId);
  return user;
};

// ✅ Bueno - Todo en español
const getUserById = async (userId) => {
  // Busca el usuario en la base de datos
  const user = await db.users.findById(userId);
  return user;
};

// ❌ Evitar - Espanglish confuso
const getUserById = async (userId) => {
  // Find el usuario en la database
  const user = await db.users.findById(userId);
  return user;
};

// ❌ Evitar - Nombres poco descriptivos
const getUsr = async (id) => {
  const u = await db.users.findById(id);
  return u;
};

PHP

// ✅ Bueno - Todo en inglés
public function getUserById(int $userId): ?User
{
    // Retrieve user from repository
    return $this->userRepository->find($userId);
}

// ✅ Bueno - Todo en español
public function getUserById(int $userId): ?User
{
    // Obtiene el usuario del repositorio
    return $this->userRepository->find($userId);
}

// ❌ Evitar - Espanglish
public function getUserById(int $userId): ?User
{
    // Retrieve el usuario del repository
    return $this->userRepository->find($userId);
}

// ❌ Evitar - Nombres poco descriptivos
public function get($id)
{
    return $this->repo->find($id);
}

Python

# ✅ Bueno - Todo en inglés
def get_user_by_id(user_id: int) -> Optional[User]:
    """Gets a user by their ID."""
    return db.users.find_by_id(user_id)

# ✅ Bueno - Todo en español
def get_user_by_id(user_id: int) -> Optional[User]:
    """Obtiene un usuario por su ID."""
    return db.users.find_by_id(user_id)

# ❌ Evitar - Espanglish
def get_user_by_id(user_id: int) -> Optional[User]:
    """Gets un usuario por su ID."""
    return db.users.find_by_id(user_id)

# ❌ Evitar - Nombres poco descriptivos
def get(id):
    return db.users.find_by_id(id)

📝 Regla de Oro sobre Idiomas

En un mismo archivo:

✅ Permitido: Todo en inglés O todo en español
✅ Tolerado: Cambiar de idioma entre funciones/clases diferentes (con moderación)
❌ Evitar: Mezclar idiomas en el mismo comentario o documentación
❌ No hacer: Espanglish constante que dificulte la lectura

🐛 Reportar Bugs

Antes de Reportar

Revisa que no exista un issue similar
Asegúrate de que realmente es un bug
Recolecta toda la información necesaria

Template de Bug Report

## Descripción del Bug
Descripción clara y concisa del bug

## Pasos para Reproducir
1. Ve a '...'
2. Haz clic en '...'
3. Desplázate hasta '...'
4. Observa el error

## Comportamiento Esperado
Lo que debería suceder

## Comportamiento Actual
Lo que realmente sucede

## Screenshots
Si aplica, agrega capturas de pantalla

## Entorno
- OS: [ej. macOS, Windows, Linux]
- Navegador: [ej. Chrome, Firefox]
- Versión: [ej. 22]

## Contexto Adicional
Cualquier otra información relevante

💡 Sugerir Mejoras

Template para Solicitud de Funcionalidad

## ¿Tu solicitud de funcionalidad está relacionada con un problema?
Descripción clara del problema. Ej: "Siempre me frustra cuando [...]"

## Describe la Solución que Te Gustaría
Descripción clara de lo que quieres que suceda

## Describe Alternativas que Consideraste
Descripción de soluciones o funcionalidades alternativas

## Contexto Adicional
Cualquier otro contexto, capturas de pantalla, etc.

🔍 Revisión de Código

Cuando revises PRs de otros:

✅ Sé constructivo y amable
✅ Explica el "por qué" de tus comentarios
✅ Sugiere alternativas cuando sea posible
✅ Reconoce el buen trabajo
❌ No seas grosero o despectivo
❌ No critiques a la persona, critica el código

📞 ¿Necesitas Ayuda?

💬 Abre una Discussion
🐛 Crea un Issue
💬 Comunícate por Discord (próximamente)
📧 Contacta al equipo: contact@amoxcalli.dev

🙏 Agradecimientos

Cada contribución, sin importar su tamaño, es valiosa para nosotros. ¡Gracias por hacer que AmoxcalliDev sea cada vez mejor!

"El código es mejor cuando se comparte"

💚 Hecho con amor desde México 🇲🇽

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🤝 Guía de Contribución - AmoxcalliDev

📋 Tabla de Contenidos

📜 Código de Conducta

🔗 Uso en Otros Repositorios

Para Repositorios Nuevos

Para Repositorios Existentes

Ventaja de Este Enfoque

🚀 ¿Cómo Puedo Contribuir?

💻 Contribuciones de Código

📝 Contribuciones sin Código

🔄 Proceso de Contribución

1️⃣ Fork y Clone

2️⃣ Crea una Rama

3️⃣ Haz tus Cambios

4️⃣ Prueba tus Cambios

5️⃣ Commit

Tipos de Commits

6️⃣ Push y Pull Request

💅 Estándares de Código

General

JavaScript/TypeScript

PHP

Python

📝 Regla de Oro sobre Idiomas

🐛 Reportar Bugs

Antes de Reportar

Template de Bug Report

💡 Sugerir Mejoras

Template para Solicitud de Funcionalidad

🔍 Revisión de Código

📞 ¿Necesitas Ayuda?

🙏 Agradecimientos

FilesExpand file tree

CONTRIBUTING.md

Latest commit

History

CONTRIBUTING.md

File metadata and controls

🤝 Guía de Contribución - AmoxcalliDev

📋 Tabla de Contenidos

📜 Código de Conducta

🔗 Uso en Otros Repositorios

Para Repositorios Nuevos

Para Repositorios Existentes

Ventaja de Este Enfoque

🚀 ¿Cómo Puedo Contribuir?

💻 Contribuciones de Código

📝 Contribuciones sin Código

🔄 Proceso de Contribución

1️⃣ Fork y Clone

2️⃣ Crea una Rama

3️⃣ Haz tus Cambios

4️⃣ Prueba tus Cambios

5️⃣ Commit

Tipos de Commits

6️⃣ Push y Pull Request

💅 Estándares de Código

General

JavaScript/TypeScript

PHP

Python

📝 Regla de Oro sobre Idiomas

🐛 Reportar Bugs

Antes de Reportar

Template de Bug Report

💡 Sugerir Mejoras

Template para Solicitud de Funcionalidad

🔍 Revisión de Código

📞 ¿Necesitas Ayuda?

🙏 Agradecimientos