apple / apple/foundationdb

Document how to run simulation tests for new contributors

Open
#2,368 4 comments 3 reactions 0 assignees View on GitHub
documentation
Dominant language
C++
Stars
16.7k
Forks
1.6k
Avg merge
1d 20h
Merged PRs (30d)
126

Description

We weirdly lack documentation for how to actually test code. It'd be good to definitely highlight cmake+ctest as the preferred workflow, but mentioning how to directly run a `./fdbserver -r simulation -b on -s 123 -f test.txt` test would be good.

Contributor guide

Open the contributing guide

Research direction

Start by locating the contributor or testing documentation and existing CMake/CTest instructions. Document the preferred CMake plus CTest workflow and the direct fdbserver entry point using `./fdbserver -r simulation -b on -s 123 -f test.txt`; done means a new contributor can run both workflows from the documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
cmake, cpp
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.