Skip to content

Commit 470052d

Browse files
authored
create: added instructions to CONTRIBUTING.md file
1 parent 0a1553e commit 470052d

1 file changed

Lines changed: 61 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Contributing to Auth-Mailer-API 📧
2+
3+
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.
4+
5+
## 🚀 How Can I Contribute?
6+
7+
### Reporting Bugs 🐛
8+
If you find a bug, please create an issue in the repository including:
9+
* A clear and descriptive title.
10+
* Steps to reproduce the problem.
11+
* What you expected to happen vs. what actually happened.
12+
13+
### Suggesting Enhancements 💡
14+
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.
15+
16+
### Pull Requests 🏗️
17+
1. Fork the repository.
18+
2. Create your feature branch (`git checkout -b feature/AmazingFeature`).
19+
3. Commit your changes using **Conventional Commits** (e.g., `feat: add social login`).
20+
4. Push to the branch (`git push origin feature/AmazingFeature`).
21+
5. Open a Pull Request.
22+
23+
## ⚖️ Style Guide
24+
* Use **ESLint** and **Prettier** for code formatting.
25+
* Ensure all tests pass (`npm test`) before submitting a PR.
26+
* Keep documentation (README) updated if you add new features.
27+
28+
---
29+
*Developed with ❤️ by Clio Salgado*
30+
31+
🔽 Versión en Español 🔽
32+
33+
# Contribuyendo a Auth-Mailer-API 📧
34+
35+
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.
36+
37+
## 🚀 ¿Cómo puedo contribuir?
38+
39+
### Reportar Errores (Bugs) 🐛
40+
Si encuentras un error, por favor crea un "Issue" en el repositorio incluyendo:
41+
* Un título claro y descriptivo.
42+
* Pasos para reproducir el problema.
43+
* Qué esperabas que sucediera frente a lo que realmente sucedió.
44+
45+
### Sugerir Mejoras 💡
46+
¿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.
47+
48+
### Pull Requests 🏗️
49+
1. Haz un Fork del repositorio.
50+
2. Crea tu rama de función o mejora (`git checkout -b feature/AmazingFeature`).
51+
3. Realiza tus cambios utilizando **Conventional Commits** (ej., `feat: add social login`).
52+
4. Sube tus cambios a la rama (`git push origin feature/AmazingFeature`).
53+
5. Abre un Pull Request.
54+
55+
## ⚖️ Guía de Estilo
56+
* Usa **ESLint** y **Prettier** para el formateo del código.
57+
* Asegúrate de que todas las pruebas pasen (`npm test`) antes de enviar un PR.
58+
* Mantén la documentación (README) actualizada si agregas nuevas funcionalidades.
59+
60+
---
61+
*Desarrollado con ❤️ por Clio Salgado*

0 commit comments

Comments
 (0)