Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (45 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

61 lines (45 loc) · 2.48 KB

Contributing to Auth-Mailer-API 📧

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 a bug, please create an issue in the repository including:

  • A clear and descriptive title.
  • Steps to reproduce the problem.
  • What you expected to happen vs. what actually happened.

Suggesting Enhancements 💡

Have an idea to make the Auth-Mailer-API better? Open an issue with the "enhancement" tag and describe the feature you'd like to see.

Pull Requests 🏗️

  1. Fork the repository.
  2. Create your feature branch (git checkout -b feature/AmazingFeature).
  3. Commit your changes using Conventional Commits (e.g., feat: add social login).
  4. Push to the branch (git push origin feature/AmazingFeature).
  5. Open a Pull Request.

⚖️ Style Guide

  • Use ESLint and Prettier for code formatting.
  • Ensure all tests pass (npm test) before submitting a PR.
  • Keep documentation (README) updated if you add new features.

Developed with ❤️ by Clio Salgado

🔽 Versión en Español 🔽

Contribuyendo a Auth-Mailer-API 📧

Antes que nada, ¡muchas gracias por considerar contribuir a este proyecto! Personas como tú son 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, por favor crea un "Issue" en el repositorio incluyendo:

  • Un título claro y descriptivo.
  • Pasos para reproducir el problema.
  • Qué esperabas que sucediera frente a lo que realmente sucedió.

Sugerir Mejoras 💡

¿Tienes una idea para hacer que Auth-Mailer-API sea mejor? Abre un "Issue" con la etiqueta "enhancement" y describe la funcionalidad que te gustaría ver.

Pull Requests 🏗️

  1. Haz un Fork del repositorio.
  2. Crea tu rama de función o mejora (git checkout -b feature/AmazingFeature).
  3. Realiza tus cambios utilizando Conventional Commits (ej., feat: add social login).
  4. Sube tus cambios a la rama (git push origin feature/AmazingFeature).
  5. Abre un Pull Request.

⚖️ Guía de Estilo

  • Usa ESLint y Prettier para el formateo del código.
  • Asegúrate de que todas las pruebas pasen (npm test) antes de enviar un PR.
  • Mantén la documentación (README) actualizada si agregas nuevas funcionalidades.

Desarrollado con ❤️ por Clio Salgado