Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (52 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

69 lines (52 loc) · 3.14 KB

Contributing to Blog Database System (PostgreSQL) 📊

First of all, thank you for considering contributing to this project! It's people like you who make the open-source community such an amazing place to learn and create.

🚀 How Can I Contribute?

Reporting Bugs 🐛

If you find an error in the SQL scripts or database logic, please create an issue in the repository including:

  • A clear and descriptive title.
  • Include the PostgreSQL error message if applicable.
  • Specify the PostgreSQL version you are using.
  • What you expected to happen vs. what actually happened.

Suggesting Enhancements 💡

Do you have an idea to optimize a query or improve the ERD design?

  • Create an Issue explaining the enhancement.
  • If you plan to implement it, please wait for discussion before sending a Pull Request.

Pull Requests 🏗️

  1. Fork the repository.
  2. Create your feature branch (git checkout -b feature/AmazingFeature).
  3. If adding new tables, ensure you update the .sql script and the ERD diagram.
  4. Maintain SQL style: Keywords in uppercase (SELECT, JOIN) and table/column names in lowercase snake_case.
  5. Commit your changes using Conventional Commits (e.g., feat: add social login).
  6. Push to the branch (git push origin feature/AmazingFeature).

⚖️ Style Guide

  • Maintain a readable format with consistent indentation (2 or 4 spaces).
  • Keep documentation (README) updated if you add new features.

Developed with ❤️ by Clio Salgado

🔽 Versión en Español 🔽

Contribuyendo a: Blog Database System (PostgreSQL) 📊

En primer lugar, ¡gracias por considerar contribuir a este proyecto! Son personas como tú las que hacen de la comunidad de código abierto un lugar increíble para aprender y crear.

🚀 ¿Cómo puedo contribuir?

Reportar Errores (Bugs) 🐛

Si encuentras un error en los scripts SQL o en la lógica de la base de datos, por favor crea un "Issue" en el repositorio incluyendo:

  • Un título claro y descriptivo.
  • El mensaje de error de PostgreSQL si es aplicable.
  • La versión de PostgreSQL que estás utilizando.
  • Qué esperabas que sucediera frente a lo que realmente sucedió.

Sugerir Mejoras 💡

¿Tienes una idea para optimizar una consulta o mejorar el diseño del diagrama ERD?

  • Crea un Issue explicando la mejora.
  • Si planeas implementarla, por favor espera a que se discuta en el Issue antes de enviar un Pull Request.

Pull Requests 🏗️

  1. Haz un Fork del repositorio.
  2. Crea tu rama de mejora (git checkout -b feature/IncreibleMejora).
  3. Si añades nuevas tablas, asegúrate de actualizar el script .sql y el diagrama ERD.
  4. Mantén el estilo SQL: Palabras clave en mayúsculas (SELECT, JOIN) y nombres de tablas/columnas en minúsculas con snake_case.
  5. Realiza tus commits usando Conventional Commits (ej: feat: add social login).
  6. Haz Push a tu rama (git push origin feature/IncreibleMejora).

⚖️ Guía de Estilo

  • Manten el formato legible con una indentación consistente (2 o 4 espacios).
  • Mantén la documentación (README) actualizada si añades nuevas funcionalidades.

Desarrollado con ❤️ por Clio Salgado