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

Write a "Day 1 with the repo" tutorial (no hardware required)

Abierto
  • ¿Algo no está bien?
#462 6 comentarios 0 reacciones 2 asignados Ver en GitHub

@DikshaGangolia ya está trabajando en esto.

Desde el 25/8/2026.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

contribute-without-a-unit good first issue help wanted lane:docs

What this is

A clean, opinionated walkthrough that takes a brand-new contributor from git clone to running the simulator/mock pipeline locally, with screenshots and exact commands. The whole point is that someone without any hardware can be productive in their first hour.

Why this matters

Documentation drift is real. The current README assumes a lot of context that new contributors don't have. A fresh-eyes pass surfaces dozens of small fixes that the regulars stopped noticing. The output is both a tutorial and a punch list of issues to file against the repo.

What to do

  1. Comment to claim.
  2. Set up a local environment following only the public docs — no help from a maintainer until you're stuck for more than 15 minutes.
  3. Write a step-by-step tutorial: every command, every screenshot, every "if this fails, try this" note.
  4. Every time you hit friction — anything that took you more than 5 minutes to figure out — file a separate issue against the repo with the title "Friction point: [thing]" and link it from the tutorial.
  5. Submit the tutorial as a PR to the wiki under "Tutorials" or "Getting Started."

Definition of done

  • Tutorial walks from git clone through running the simulator/mock pipeline without referencing any hardware.
  • At least three screenshots showing key steps.
  • All commands tested and known-good on a fresh machine.
  • Friction-point issues filed for every spot that took >5 minutes to figure out.
  • Reviewed by a maintainer.

Skills

  • Technical writing
  • Willingness to follow instructions exactly and notice when they break
  • A computer you can install fresh dependencies on

Scope estimate

6–8 hours.

Helpful starting points

How to claim this issue

  1. Comment "I'd like to work on this" — we'll assign it to you.
  2. Open a draft PR within ~2 weeks of being assigned.
  3. Ask any setup questions on this issue or in our Discord #contributing channel.

Contact: [email protected]

By contributing, you agree to our Contributor License Agreement. (If the CLA isn't yet live when you start, we'll handle it once the flow is up.)

Lenguaje dominante
Python
Estrellas
29
Forks
20
Merge medio
4 h 31 min
PR fusionados (30 d)
6

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 OpenwaterHealth/openlifu-python

Todos los issues de OpenwaterHealth/openlifu-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.