adinmg / Contribution-Guidelines

Guide for contributions

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Contribuir a la AMEA (Version ESP)

⛄️❄️Gracias por dedicar su tiempo a contribuir a esta organización.⛄️❄️

A continuación se exponen las indicaciones para contribuir a la AMEA.

¿Cómo contribuir?

Visualización de los datos de la Antártida

Esta sección te guía para que envíes tus visualizaciones y hallazgos. Seguir estas indicaciones ayuda a los mantenedores y a la comunidad a entender su hallazgo y a reproducir los resultados.

  1. Necesitará un archivo README con la descripción de su hallazgo utilizando el modelo STAR.

Modelo STAR

  • Situación: Describe la situación y cuando ocurrio.
  • Tarea: Expliqua la tarea y cuál es el objetivo.
  • Acción: Proporciona detalles sobre la acción que llevaste a cabo para conseguirlo.
  • Resultado: Concluye con el resultado de tu acción.

Referencia

  1. Deberas proporcionar el código en formato de Notebook (archivo .ipynb).
  • Estructure su cuaderno, puede utilizar también el modelo STAR.
  • Por favor, intenta seguir en lo posible el estilo de PEP 8 cuando escribas tu codigo.
  • Ten comentarios en tu código explicando lo que hace el bloque de código
  1. Crea una carpeta que contenga el archivo README y el Python Notebook. La carpeta debería llamarse así "Nombre_del_proyecto_su_nombre".

Contributing to AMEA (English Version)

⛄️❄️Thank you for taking your time in contributing to this organization!⛄️❄️

The following is a set of guidelines for contributing to AMEA.

How to contribute?

Visualization of Antarctic Data

This section guides you through submitting your visualizations and findings. Following these guidelines helps maintainers and the community understand your finding and reproduce the results.

  1. You will need a README file with the description of your finding using the STAR model.

STAR Model

  • Situation: Describe the situation and when it took place.
  • Task: Explain the task and what was the goal.
  • Action: Provide details about the action you took to attain this.
  • Result: Conclude with the result of your action.

Reference

  1. You will need to provide the code in a notebook format (.ipynb file).
  • Structure your notebook, you can use the STAR model too.
  • Please try to follow as much as you can the PEP 8 coding style
  • Have comments in your code explaining what the code block does
  1. Create a folder that contains the README file and the Python Notebook. The folder should be name like this "Project_Name_YourName"

About

Guide for contributions