atom-archive/xray

Help wanted: Benchmarks in xray_core

Open

#21 opened on Mar 6, 2018

View on GitHub
 (9 comments) (5 reactions) (0 assignees)Rust (8,531 stars) (248 forks)batch import
good first issuehelp wanted

Description

It would be great to get a PR setting up benchmarks on xray_core in the canonical Rust manner. You can use your imagination on the kinds of operations we want to test, but here are some ideas:

  • Making large numbers of edits
  • Moving large numbers of cursors in a document containing large numbers of edits

Just getting a basic framework in place with some non-trivial benchmark would be helpful.

Contributor guide

Tech stack
rust
Domain
performance
Issue type
performance
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Rust programmingfamiliarity with criterion or similar benchmarking crate
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Start by exploring the xray core crate structure in the repository. Look into Rust benchmarking crates like `criterion` or `bencher` to set up a benchmark suite. Implement benchmarks for operations such as making large numbers of edits and moving cursors in a document with many edits. Since the repository is archived, consider that any work would be for learning purposes only.