Skip to content

Move benchmark/README.md to doc/guide #11190

Closed
Closed
Move benchmark/README.md to doc/guide#11190
Labels
benchmarkIssues and PRs related to Node.js benchmarks and benchmarking infrastructure.docIssues and PRs related to Node.js documentation.

Description

@joyeecheung
joyeecheung
opened on Feb 6, 2017

The current benchmark/README.md is in fact a guide on how to run and write benchmarks, I suggest we move this to doc/guides (where writing-tests.md is) and create another README.md that explains the directory layout/common API (like what test/README.md does).

cc @nodejs/collaborators

Activity

  1. joyeecheung
    added
    docIssues and PRs related to Node.js documentation.
    benchmarkIssues and PRs related to Node.js benchmarks and benchmarking infrastructure.
    on Feb 6, 2017

  2. evanlucas commented on Feb 6, 2017

    @evanlucas
    evanlucas
    on Feb 6, 2017
    Contributor

    I think it makes sense to have a README that explains how to run the benchmarks in the benchmarks directory, but I do think that the guide on how to write one should be in guides (linked from the readme)

  3. joyeecheung commented on Feb 7, 2017

    @joyeecheung
    joyeecheung
    on Feb 7, 2017
    MemberAuthor

    I think it makes sense to have a README that explains how to run the benchmarks in the benchmarks directory, but I do think that the guide on how to write one should be in guides (linked from the readme)

    I agree, the same can be done to test/README.md too. I'll prepare a PR for that :)

  4. joyeecheung
    closed this as completedin 4bed6d6on Feb 17, 2017
  5. joyeecheung
    added 2 commits that reference this issue on Feb 17, 2017

    doc: add benchmark/README.md and fix guide

    8926f11

    doc: improve test/README.md

    736814e
  6. addaleax
    added 3 commits that reference this issue on Feb 22, 2017

    doc: move benchmark/README.md to doc/guides

    22a6edd

    doc: add benchmark/README.md and fix guide

    5d12fd9

    doc: improve test/README.md

    66f9506
  7. jasnell
    added a commit that references this issue on Mar 7, 2017

    doc: improve test/README.md

    5f1b9a4
  8. MylesBorins
    added a commit that references this issue on Mar 9, 2017

    doc: improve test/README.md

    0164d92
  9. sjarmak
    added a commit that references this issue on Jul 27, 2026

    doc: move benchmark/README.md to doc/guides

    4bed6d6
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    benchmarkIssues and PRs related to Node.js benchmarks and benchmarking infrastructure.docIssues and PRs related to Node.js documentation.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions