Skip to content

Commit 320c835

Browse files
committed
add contribution tips to README
1 parent 316322e commit 320c835

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,20 @@
11
# BaseBenchmarks.jl
22

3-
This package is a collection of Julia benchmarks available for CI tracking from the JuliaLang/julia repository.
3+
This package is a collection of Julia benchmarks available for CI performance tracking from the JuliaLang/julia repository.
4+
5+
#### Contributing
6+
7+
Our performance tracker could always benefit from more benchmarks! If you have a benchmark that depends only on `Base` Julia code, it is welcome here.
8+
9+
Here are some contribution tips:
10+
11+
- You'll need to use [BenchmarkTrackers.jl](https://github.com/JuliaCI/BenchmarkTrackers.jl) to write the benchmarks (feel free to open a WIP PR if you'd like help with this).
12+
- Newly defined functions whose calls are measured should have `perf_` prepended to their name. This makes it easier to find a given benchmark's "entry point" in the code.
13+
- Try to reuse existing tags when possible. Tags should be lowercase and singular.
14+
- If your benchmark requires a significant amount of code, wrap it in a module.
15+
16+
#### Versioning
417

518
The `master` branch holds benchmarks written for Julia v0.5, while the `release-0.4` branch holds benchmarks written for Julia v0.4. These branches should differ as little as possible - they only exist separately to avoid breakage between versions.
619

7-
To see what versions of this package are currently deployed on our CI tracking hardware, simply refer to the tags: the latest version tagged `vA.B.C` is currently deployed to test Julia `vA.B`. For example, BaseBenchmarks.jl version `v0.5.x` runs against Julia v0.5, while BaseBenchmarks.jl version `v0.4.x` runs against Julia v0.4.
20+
To see what versions of this package are currently deployed on our CI tracking hardware, simply refer to the git tags: the latest version tagged `vA.B.C` is currently deployed to test Julia `vA.B`. For example, BaseBenchmarks `v0.5.x` runs against Julia v0.5, while BaseBenchmarks `v0.4.x` runs against Julia v0.4.

0 commit comments

Comments
 (0)