fsprojects / fsprojects/FSharpx.Collections

CircularBuffer has no tests

Open
#16 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug help wanted 2.0
Dominant language
F#
Stars
253
Forks
76
Avg merge
49m
Merged PRs (30d)
1

Description

CircularBuffer has no tests. Also it would be nice to have a comment which says how this structure differs from RingBuffer, which also exists in the codebase.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the CircularBuffer and RingBuffer implementations and inspect the repository's existing test layout and conventions. Add coverage for CircularBuffer and a comment explaining how it differs from RingBuffer, then run the test suite to confirm the new tests pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
fsharp
Domain
documentation, testing
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.