[{"data":1,"prerenderedAt":402},["ShallowReactive",2],{"doc-contributing":3},{"id":4,"title":5,"body":6,"description":392,"extension":393,"meta":394,"navigation":395,"path":396,"seo":397,"slug":398,"source":399,"stem":400,"__hash__":401},"docs\u002Fdocs\u002Fcontributing.md","Contributing to Catch3",{"type":7,"value":8,"toc":383},"minimark",[9,13,60,81,85,88,91,100,110,117,134,140,143,146,152,159,165,175,295,298,308,332,337,340,354,357,373,376],[10,11,5],"h1",{"id":12},"contributing-to-catch3",[14,15,16,20,23,28,30,34,36,40,42,46,48,52,54,58],"p",{},[17,18,19],"strong",{},"Contents",[21,22],"br",{},[24,25,27],"a",{"href":26},"#where-to-start","Where to start",[21,29],{},[24,31,33],{"href":32},"#building-and-testing","Building and testing",[21,35],{},[24,37,39],{"href":38},"#two-parts-two-sets-of-rules","Two parts, two sets of rules",[21,41],{},[24,43,45],{"href":44},"#tests","Tests",[21,47],{},[24,49,51],{"href":50},"#documentation","Documentation",[21,53],{},[24,55,57],{"href":56},"#code-of-conduct","Code of Conduct",[21,59],{},[14,61,62,63,69,70,74,75,80],{},"Progmasoft maintains Catch3. Issues and pull requests are welcome on\n",[24,64,68],{"href":65,"rel":66},"https:\u002F\u002Fgithub.com\u002FProgmasoft\u002Fcatch3",[67],"nofollow","Progmasoft\u002Fcatch3","; pull requests go\nto the ",[71,72,73],"code",{},"devel"," branch. Report security problems privately, as described in\n",[24,76,79],{"href":77,"rel":78},"https:\u002F\u002Fgithub.com\u002FProgmasoft\u002Fcatch3\u002Fblob\u002Fdevel\u002FSECURITY.md",[67],"SECURITY.md",", not in a public issue.",[82,83,27],"h2",{"id":84},"where-to-start",[14,86,87],{},"Open an issue before a large change, so that the direction can be agreed\nfirst. A pull request should do one thing, say why in its description and\ncome with the tests that show it works.",[82,89,33],{"id":90},"building-and-testing",[14,92,93,94,99],{},"Bazel is the main build. With ",[24,95,98],{"href":96,"rel":97},"https:\u002F\u002Fgithub.com\u002Fbazelbuild\u002Fbazelisk",[67],"Bazelisk",":",[101,102,107],"pre",{"className":103,"code":105,"language":106},[104],"language-text","bazelisk test \u002F\u002Ftests\u002F...\n","text",[71,108,105],{"__ignoreMap":109},"",[14,111,112,113,116],{},"On Windows, point Bazel at Git's bash first:\n",[71,114,115],{},"BAZEL_SH=\"C:\\Program Files\\Git\\usr\\bin\\bash.exe\"",".",[14,118,119,120,125,126,129,130,133],{},"CMake builds every test, including the extra tests that check compile-time\nconfigurations. Their scripts need Python 3 with\n",[24,121,124],{"href":122,"rel":123},"https:\u002F\u002Fpypi.org\u002Fproject\u002Fdefusedxml\u002F",[67],"defusedxml"," (",[71,127,128],{},"python3-defusedxml"," on\nDebian, Ubuntu and Fedora, or ",[71,131,132],{},"requirements-tests.txt","):",[101,135,138],{"className":136,"code":137,"language":106},[104],"cmake --preset basic-tests -GNinja -DCATCH3_BUILD_EXTRA_TESTS=ON -DCATCH3_BUILD_EXAMPLES=ON\ncmake --build build\nctest --test-dir build -j\n",[71,139,137],{"__ignoreMap":109},[14,141,142],{},"Meson, Xmake and Premake builds exist as well and are checked in CI.",[14,144,145],{},"Before you push, run the repository checks:",[101,147,150],{"className":148,"code":149,"language":106},[104],"bazelisk run \u002F\u002Ftools:check\n",[71,151,149],{"__ignoreMap":109},[14,153,154,155,158],{},"It checks licenses, convenience headers, header guards, file names, that every\nplace states the same version, and that the single-file distribution is up to\ndate. A change to anything under ",[71,156,157],{},"src\u002F"," regenerates that distribution:",[101,160,163],{"className":161,"code":162,"language":106},[104],"bazelisk run \u002F\u002Ftools:amalgamate\n",[71,164,162],{"__ignoreMap":109},[14,166,167,168,171,172,99],{},"The tools in ",[71,169,170],{},"tools\u002F"," are C++17 and run through Bazel, with arguments after\n",[71,173,174],{},"--",[176,177,178,191],"table",{},[179,180,181],"thead",{},[182,183,184,188],"tr",{},[185,186,187],"th",{},"Tool",[185,189,190],{},"Does",[192,193,194,209,219,243,264,277],"tbody",{},[182,195,196,202],{},[197,198,199],"td",{},[71,200,201],{},"\u002F\u002Ftools:amalgamate",[197,203,204,205,208],{},"writes the single-file distribution; ",[71,206,207],{},"-- --check"," only compares it",[182,210,211,216],{},[197,212,213],{},[71,214,215],{},"\u002F\u002Ftools:check",[197,217,218],{},"runs the repository checks",[182,220,221,226],{},[197,222,223],{},[71,224,225],{},"\u002F\u002Ftools:third_party",[197,227,228,230,231,234,235,238,239,242],{},[71,229,207],{}," compares ",[71,232,233],{},"third_party\u002F"," with the archives ",[71,236,237],{},"MODULE.bazel"," pins, ",[71,240,241],{},"-- --update"," writes it",[182,244,245,250],{},[197,246,247],{},[71,248,249],{},"\u002F\u002Ftools:version",[197,251,252,253,125,256,259,260,263],{},"prints the version; ",[71,254,255],{},"-- \u003Cversion>",[71,257,258],{},"MAJOR.MINOR.PATCH",") or ",[71,261,262],{},"-- --next"," (the next patch release) moves every place that states it, and the distribution",[182,265,266,271],{},[197,267,268],{},[71,269,270],{},"\u002F\u002Ftools:release_notes",[197,272,273,274,276],{},"prints a section of the release notes, of ",[71,275,255],{}," or the current one",[182,278,279,284],{},[197,280,281],{},[71,282,283],{},"\u002F\u002Ftools:repo_info",[197,285,286,287,290,291,294],{},"reports the checkout and the tools on ",[71,288,289],{},"PATH","; ",[71,292,293],{},"-- --json"," writes it as JSON",[82,296,39],{"id":297},"two-parts-two-sets-of-rules",[14,299,300,303,304,307],{},[71,301,302],{},"src\u002Fcatch2"," is the compatibility engine taken from Catch2. Its public API is\nwhat Catch3 promises to keep: code that compiles against Catch2's headers\nmust keep compiling. It stays under the Boost Software License 1.0, keeps the\n",[71,305,306],{},"Catch2 Authors"," header and follows the style of the surrounding Catch2 code.\nCode that includes its headers needs C++17 or later.",[14,309,310,313,314,317,318,323,324,327,328,331],{},[71,311,312],{},"src\u002FProgmasoft"," holds what Progmasoft adds: the runner, the results model,\nproperty testing and snapshots. It is licensed ",[71,315,316],{},"LGPL-3.0-or-later",", follows the\n",[24,319,322],{"href":320,"rel":321},"https:\u002F\u002Fgithub.com\u002FProgmasoft\u002Fprogmasoft-cpp",[67],"Progmasoft Core C++ Coding Guidelines",", is\nC++17, reports recoverable errors with ",[71,325,326],{},"Expected"," rather than exceptions, and\nis formatted with the ",[71,329,330],{},".clang-format"," beside it.",[14,333,334,336],{},[71,335,215],{}," checks that every source file carries the header of its part.",[82,338,45],{"id":339},"tests",[14,341,342,345,346,349,350,353],{},[71,343,344],{},"tests\u002FSelfTest"," tests the compatibility engine; ",[71,347,348],{},"tests\u002FExtraTests"," tests\ncompile-time configurations and the runner's behaviour around them;\n",[71,351,352],{},"tests\u002FProgmasoft"," tests the Progmasoft code, and the runner's integration\ntests there start a fixture binary whose tests misbehave on purpose. A bug fix\ncomes with a test that fails without it.",[82,355,51],{"id":356},"documentation",[14,358,359,360,363,364,368,369,116],{},"User documentation lives in ",[71,361,362],{},"docs\u002F",". A new page is linked from\n",[24,365,367],{"href":366},"\u002Fdocs\u002F","the documentation index",", and a page with sections gets a table\nof contents.\nA user-visible change gets a line in ",[24,370,372],{"href":371},"\u002Fdocs\u002Fchangelog\u002F","the release notes",[82,374,57],{"id":375},"code-of-conduct",[14,377,378,379,116],{},"Everyone who takes part follows the ",[24,380,57],{"href":381,"rel":382},"https:\u002F\u002Fgithub.com\u002FProgmasoft\u002Fcatch3\u002Fblob\u002Fdevel\u002FCODE_OF_CONDUCT.md",[67],{"title":109,"searchDepth":384,"depth":384,"links":385},2,[386,387,388,389,390,391],{"id":84,"depth":384,"text":27},{"id":90,"depth":384,"text":33},{"id":297,"depth":384,"text":39},{"id":339,"depth":384,"text":45},{"id":356,"depth":384,"text":51},{"id":375,"depth":384,"text":57},"ContentsWhere to startBuilding and testingTwo parts, two sets of rulesTestsDocumentationCode of Conduct","md",{},true,"\u002Fdocs\u002Fcontributing",{"title":5,"description":392},"contributing","docs\u002Fcontributing.md","docs\u002Fcontributing","MIy9GTh41jS3BwXw7D6FX610DCJ8NM2HTS-tEqSiEIo",1794961591527]