Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

[Meta] Ways to Contribute

Abierto
#39 14 comentarios 1 reacción 1 asignado Ver en GitHub

@TimidRobot ya está trabajando en esto.

Desde el 3/3/2023.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

✨ goal: improvement 🌟 goal: addition 🏷 status: label work required 💬 talk: discussion 💻 aspect: code 🤖 aspect: dx good first issue help wanted 🟨 priority: medium

Overview

⚠️ This meta-issue should not be worked on itself. Instead it is a place for me (@TimidRobot) to document ways to engage with this project.

First

Ways to Contribute

  • Pull Requests (PRs)
  • Issues
    • Create a new issue recommending a data source that should be included. Include information like:
      • quantity of records
      • types of metadata available
      • API documentation link
      • API requirements and limitations
      • Also see
    • Create a new issue related to a single script or data source:
      • Scripts should be using .env (theskumar/python-dotenv) and not query_secrets.py or similar
      • Scripts mustn't be monolithic--they should be limited to a single phase (ex. query, process, report. See #22)
      • Scripts must be designed to be run from the repository root via pipenv (ex. pipenv run PATH/SCRIPT.PY)
        • Script should determine its own path and set appropriate global variables (ex. DIR_ROOT, DIR_SCRIPT)
      • Scripts have a lot of duplication between them. Begin a shared library (remember to keep issues as small and descrete as possible--limit each issue/PR to a single script or data source).
      • Scripts should be using retries with exponential backoff (ex. #2)

Tips

Conventions and best practices
Plot process data

Any plots in phase 3-report should graph data without significantly modifying it. This means that development of phase 2-process and phase 3-report usually needs to be done at the same time.

Put another way, there should be a 1:1 relationship between phase 3-report plots and phase 2-process CSV files.

Lenguaje dominante
Python
Estrellas
48
Forks
74
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de creativecommons/quantifying

Todos los issues de creativecommons/quantifying

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.