-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
115 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
|
||
# 🛠️ Guía de Contribuciones - Sistemas Programables | ||
|
||
¡Gracias por tu interés en contribuir a este repositorio! 🎉 | ||
Este espacio está diseñado para fomentar la colaboración entre estudiantes y docentes en el desarrollo de proyectos relacionados con **Sistemas Programables**. Para mantener un entorno organizado y eficiente, sigue estas normas al contribuir. | ||
|
||
--- | ||
|
||
## 📌 ¿Cómo Contribuir? | ||
Puedes colaborar de varias maneras: | ||
- Mejorando la documentación (ej. corregir errores o agregar ejemplos). | ||
- Subiendo soluciones a ejercicios o prácticas. | ||
- Proponiendo nuevos proyectos o mejoras a los existentes. | ||
- Reportando errores o problemas en el código. | ||
- Mejorando la organización del repositorio. | ||
|
||
--- | ||
|
||
## 🔄 **Flujo de Contribución** | ||
Sigue estos pasos para contribuir correctamente: | ||
|
||
### 1️⃣ **Haz un Fork del Repositorio** | ||
Crea una copia en tu cuenta de GitHub presionando el botón **Fork** en la parte superior derecha de la página del repositorio. | ||
|
||
### 2️⃣ **Clona tu Fork en Local** | ||
```bash | ||
git clone https://github.com/TU-USUARIO/Sistemas-Programables.git | ||
cd Sistemas-Programables | ||
``` | ||
|
||
### 3️⃣ **Crea una Rama Nueva** | ||
Usa un nombre descriptivo para tu rama: | ||
```bash | ||
git checkout -b feature/nombre-de-tu-cambio | ||
``` | ||
|
||
Ejemplos de nombres de rama: | ||
- `feature/mejoras-documentacion` | ||
- `bugfix/error-en-codigo` | ||
- `project/nuevo-proyecto` | ||
|
||
### 4️⃣ **Realiza los Cambios y Confirma los Cambios** | ||
Haz modificaciones en tu código y confirma los cambios: | ||
```bash | ||
git add . | ||
git commit -m "Descripción clara de los cambios realizados" | ||
``` | ||
|
||
### 5️⃣ **Sube tu Rama al Repositorio** | ||
```bash | ||
git push origin feature/nombre-de-tu-cambio | ||
``` | ||
|
||
### 6️⃣ **Crea un Pull Request (PR)** | ||
1. Ve a **GitHub** y abre un **Pull Request** en la rama principal (`main` o `master`). | ||
2. Agrega una descripción clara de tu contribución. | ||
3. Espera la revisión y aprobación. | ||
|
||
--- | ||
|
||
## ✅ **Buenas Prácticas para Contribuir** | ||
Sigue estas recomendaciones para garantizar una contribución efectiva: | ||
|
||
### 📂 Organización del Código | ||
- Usa nombres de archivos y carpetas descriptivos. | ||
- Mantén el código modular y bien documentado. | ||
- Agrega comentarios explicativos donde sea necesario. | ||
|
||
### 📑 Documentación | ||
- Agrega un archivo `README.md` en cada nueva carpeta de proyecto o ejercicio. | ||
- Usa **Markdown (`.md`)** para documentar claramente. | ||
- Si agregas código, explica su propósito y cómo ejecutarlo. | ||
|
||
### 🏗️ Estilo de Código | ||
- Sigue las **convenciones de codificación** del lenguaje utilizado. | ||
- Usa **indentación y espaciado adecuados**. | ||
- No subas archivos innecesarios como compilados o caché. | ||
|
||
### 🚨 Reportar Problemas (Issues) | ||
Si encuentras errores o tienes sugerencias, puedes abrir un **Issue**: | ||
1. Ir a la pestaña **Issues** en GitHub. | ||
2. Presionar **New Issue**. | ||
3. Explicar el problema con detalles y adjuntar ejemplos si es posible. | ||
|
||
--- | ||
|
||
## 📜 Código de Conducta | ||
Para garantizar un ambiente colaborativo y respetuoso: | ||
- Sé amable y paciente con los demás colaboradores. | ||
- No uses lenguaje ofensivo o discriminatorio. | ||
- Respeta las opiniones y código de los demás. | ||
- Sigue las indicaciones del docente o mantenedores del repositorio. | ||
|
||
Para más detalles, revisa el [`code-of-conduct.md`](code-of-conduct.md). | ||
|
||
--- | ||
|
||
## 🔗 Recursos Útiles | ||
- [Guía Oficial de GitHub para Contribuir a Proyectos](https://docs.github.com/es/get-started/quickstart/contributing-to-projects) | ||
- [Markdown Cheat Sheet](https://www.markdownguide.org/cheat-sheet/) | ||
- [Git Flow - Buenas Prácticas](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) | ||
|
||
--- | ||
|
||
## 📧 Contacto | ||
Si tienes dudas o sugerencias, puedes comunicarte con el docente o los administradores del repositorio. | ||
|
||
📩 **Correo:** rene.solis@tectijuana.mx | ||
📍 **Institución:** TecNM - Campus Instituto Tecnológico de Tijuana | ||
|
||
--- | ||
|
||
🚀 **¡Tu participación es clave para enriquecer este curso y aprender juntos!** 🎯 | ||
|
||
|