python / python/devguide

Add steps needed to run a basic performance test in benchmarks

Aberta
#187 1 comentário 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

topic-test type-feature
Linguagem predominante
Python
Estrelas
2.1k
Forks
1k
Merge médio
2d 12h
PRs com merge (30d)
12

Descrição

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.

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece pela seção benchmarks de runtests.rst e consulte o README.txt do pyperformance para ver os comandos e as opções usados com compare_to. Adicione uma seção curta “como comparar entre commits” com os comandos mínimos e um link para a documentação de performance. O trabalho estará concluído quando os contribuidores puderem iniciar uma comparação sem precisar descobrir a sequência de comandos por conta própria.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
1/5
Tempo estimado
1-3 horas
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
48/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.