python / python/devguide

Add steps needed to run a basic performance test in benchmarks

未关闭
#187 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

topic-test type-feature
主要语言
Python
星标
2.1k
派生
1k
平均合并
2 天 12 小时
30 天内合并 PR
12

描述

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.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 runtests.rst 的 benchmarks 部分开始,并查看 pyperformance README.txt,了解与 compare_to 一起使用的命令和选项。添加一个简短的“如何比较不同 commit”部分,其中包含最少的命令以及指向性能文档的链接。当贡献者无需自行摸索命令顺序即可开始比较时,即视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
1/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
基本清楚
新手友好度
48/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。