Make sponsoring visible and meaningful: README section, tier rewards and the web book

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

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
47/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
github
Área
content, documentation

Línea de trabajo

Start with the repository README and identify where a “Support this project” section fits; include the stated funding uses, rewards, and Sponsors profile link. The web book work depends on #166: add a sponsor link in its footer and an acknowledgments page that lists sponsors with their consent. The maintainer must also configure the tiers and deliverable based goal in the Sponsors dashboard; the issue is done when all three items are complete.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

documentation

Part of #183.

Problem

The GitHub Sponsors profile is public, but nothing in the repository mentions it except the Sponsor button. It doesn't say what the money is used for or what sponsors get, and the goal ("$50 per month") isn't tied to any part of the roadmap. As a result, people who find the project useful don't see a reason to sponsor it.

Expected change

  1. README: a short "Support this project" section that says
    • what sponsoring pays for: time to write the book (#165), add algorithms (#131) and keep the project maintained
    • what sponsors get (the rewards below), with a link to the Sponsors profile
  2. Tiers and goal (set by the maintainer in the Sponsors dashboard):
    • Rewards that don't create ongoing obligations, for example:
      • $5/month: your name in the acknowledgments of the book
      • $15/month: the above, plus early access to chapter drafts
      • $100/month or more (companies): your logo in the README and in the web book
    • No rewards that promise individual support (priority answers, private consulting)
    • A goal that names a deliverable, for example "Finish Part II of the web book"
  3. Web book (#166): a sponsor link in the footer, and an acknowledgments page that lists sponsors (with their consent)

Done when

  • The README has the "Support this project" section
  • The Sponsors profile shows the new tiers and goal
  • The web book has the sponsor link and the acknowledgments page

Depends on #166 for item 3.

Lenguaje dominante
Python
Estrellas
1.9k
Forks
313
Merge medio
1 d 7 h
PR fusionados (30 d)
21

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

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 ShisatoYano/AutonomousVehicleControlBeginnersGuide

Todos los issues de ShisatoYano/AutonomousVehicleControlBeginnersGuide

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.