Add steps needed to run a basic performance test in benchmarks

Abierto
#187 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
48/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python
Área
documentation

Línea de trabajo

Comienza con la sección benchmarks de runtests.rst y revisa el README.txt de pyperformance para consultar los comandos y las opciones que se usan con compare_to. Añade una sección breve «cómo comparar entre commits» con los comandos mínimos y un enlace a la documentación de performance. Se considera completado cuando los colaboradores pueden iniciar una comparación sin tener que descubrir por sí mismos la secuencia de comandos.

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

Descripción

topic-test type-feature

It would be a nice addition to the devguide if the benchmarks section of runtests.rst contained the minimal commands needed to run pyperformance for comparing the potential performance diffs introduced by a change a user performed. Usually when a performance issue arises, the result of compare_to is posted for others to examine.

Specifically, if possible, a small section of the form "how to compare between commits" and with what options set would be ideal. Because pyperformance takes a considerable amount of time to finish, getting the right commands from the start would save people (myself included :-) quite some time.

Though it might be argued that this should go in the docs for performance I think having a small set of commands in the devguide with a see more pointing to the README.txt of the repo might be better.

Lenguaje dominante
Python
Estrellas
2.1k
Forks
1k
Merge medio
2 d 12 h
PR fusionados (30 d)
12

Guía de contribución

Abrir la 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 python/devguide

Todos los issues de python/devguide

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.