Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update the package name and version #7

Merged
merged 1 commit into from
Jan 10, 2025
Merged

chore: update the package name and version #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Benchmark

> This is an independently maintained fork of [@dapplion/benchmark](https://github.com/dapplion/benchmark).
This repo now maintains it's own versioning as `@chainsafe/benchmark` and release schedule. It was forked from the base of `@dapplion/[email protected]` and new functionality was added.

Ensures that new code does not introduce performance regressions with CI. Tracks:

- Do PR against the base branch include a performance regression?
Expand All @@ -12,7 +15,7 @@ This tooling provides both a easy to use runner for benchmarking and easy integr
Create a benchmark test file but use `itBench` instead of `it`

```ts
import {itBench, setBenchOpts, describe} from "../../src";
import {describe, itBench, setBenchOpts} from "@chainsafe/benchmark";

describe("Sum array benchmark", () => {
itBench("sum array with reduce", () => {
Expand Down
8 changes: 4 additions & 4 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "@dapplion/benchmark",
"version": "1.0.0",
"repository": "[email protected]:dapplion/benchmark.git",
"author": "dapplion <[email protected]>",
"name": "@chainsafe/benchmark",
"version": "1.1.0.rc-0",
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only key factor is the version number. As we forked the repo from the version 1.0.0 originally, But it's a newer package completely, should we use 1.1.0 or start from zero versioning 0.1.0?

Copy link
Member

@nflaig nflaig Jan 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's stable enough I would go with 1.1.0 or even 1.0.0 since it's a new package... 0.x.x is really the lazy way to do versioning and is pretty bad for consumers

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are lot of thoughts behind zero versioning scheme. https://0ver.org/

"repository": "[email protected]:chainsafe/benchmark.git",
"author": "ChainSafe Systems",
"license": "MIT",
"bin": {
"benchmark": "./bin/index.js"
Expand Down
Loading