Improve developer documentation
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 55/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Start with CONTRIBUTING.md at the repository root and follow the four requested changes: put the Python installation section first, link to the CI build configuration, add a short overview of repo structure and test strategy, and note when a CHANGELOG entry is needed. The payload does not name the CI config file or the test layout, so find those yourself. Done means the document reads in order for a new contributor, and someone has followed it on a clean machine, including the Python version issue on macOS 11 that the issue reports.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
This could be as simple as updating the CONTRIBUTING.md to be more accessible:
- start with recommended system installation of python(s) first before other sections
- link to the configuration of the commands run on CI build + expectations on what is done locally vs. at pr-time
- high-level overview of repo structure and test strategy (old strategy vs. new, where to add tests and when)
- the need for a CHANGELOG message
Also I'd recommend trying a fresh setup by literally following the instructions, it's quite sparse, and as I said, I cannot get python <= 3.6 functioning on my machine, so others running a similar later version of macOS 11 are likely to experience the same issue.
- Lenguaje dominante
- Python
- Estrellas
- 214
- Forks
- 68
- Merge medio
- 51 min
- PR fusionados (30 d)
- 6
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de Backblaze/b2-sdk-python
-
Download and copy sync actions print remote file names without escape_control_charsPosiblemente ocupada @dreyfus92 la tomó hace 15 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Backblaze/b2-sdk-python#631 ·
Los mantenedores suelen responder en 1 día
-
SqliteAccountInfo profile name validation uses "re.match", so only the first character is checkedPosiblemente ocupada @nazarli-shabnam la tomó hace 9 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
Backblaze/b2-sdk-python#629 ·
Los mantenedores suelen responder en 1 día
-
Adopt the AI-native SDLC and repository policiesPosiblemente ocupada @goanpeca la tomó hace 18 días. Abiertoenhancement
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
Backblaze/b2-sdk-python#634 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 4/5 3-5 días Aptitud para principiantes 50/100
Backblaze/b2-sdk-python#630 ·
Los mantenedores suelen responder en 1 día
-
ci: cli-compat fails — 4 sse/sync integration tests broken in B2_Command_Line_Tool (all environments)Quizá libre de nuevo @ffumero2003 la tomó hace 37 días y no hay ningún pull request abierto. Abiertobug testing
Backblaze/b2-sdk-python#627 · 2 comentarios · 1 asignado ·
Los mantenedores suelen responder en 1 día
Todos los issues de Backblaze/b2-sdk-python
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
btclib-org/btclib-node#2505 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
open-webui/open-webui#34462 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
gorakhargosh/watchdog#1462 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
openwisp/openwisp-monitoring#889 ·
Los mantenedores suelen responder en 2 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
IETF-Hackathon/pqc-certificates#351 ·
Los mantenedores suelen responder en 2 días