realpython / realpython/python-guide
Clarification on Sample Repository Structure
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Batchfile
- Estrellas
- 29.8k
- Forks
- 5.9k
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
In Structuring Your Project (/writing/structure/) the section Sample Repository is a little confusing (at least for me).
- Stating that this is the way Kenneth Reitz recommends structuring a project is a little confusing. Is there another way? (I'm sure there are) If so, is Reitz's way the de facto standard or is there another standard out there? (Perhaps links to some other popular structures would be helpful)
- On the same vein as 1 above, in most areas the guide is opinionated but in this section by stating its the way Reitz does it, it becomes very unopinionated and this sticks out. Does this mean that the authors aren't agreed upon Reitz's methodology?
- We haven't talked about setup.py up to this point in the guide. What is it? (https://stackoverflow.com/questions/1471994/what-is-setup-py)
- Here it is suggested we use requirements.txt although earlier we are encouraged to use pipenv and its pipfile (although we are also shown how to use virtualenv directly), this is a bit confusing as there is no mention of a pipfile at all. Might be helpful to expand to include some notes on the pipfile and whether we should include both or one over the other.
- The suggested project structure doesn't include context.py, but this seems to be as much a core part as the rest of the test files - should this be added?
- The section on Makefile is also confusing - there is no reference to Makefile in the initial project structure; when exactly might one use this?
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.
Línea de trabajo
Comienza con la sección Sample Repository en /writing/structure/ y lee las indicaciones circundantes sobre setup.py, requirements.txt, Pipfile, virtualenv, context.py y Makefile. Compara la estructura del proyecto y el flujo de trabajo descritos y, después, identifica qué explicaciones o enlaces necesitan aclaración. Se considera terminado cuando la sección explica de forma coherente sus recomendaciones, alternativas y el papel de cada archivo mencionado.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100