From 845b7867f07519957d1811f6a4e3284791f877a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20=C5=81oskot?= Date: Sun, 7 Aug 2022 01:01:02 +0200 Subject: [PATCH] Clarify contributor guidelines about versions requirement (#179) Follow up to https://github.com/bfgroup/b2/discussions/176 --- CONTRIBUTING.adoc | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index da590db5e..85a1a4438 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -152,6 +152,11 @@ Developing in the `b2` engine, the C++ part, requires two steps to be effective: building the "stable" engine, and developing the "in-progress" engine. +CAUTION: The `b2` only supports building when the version of the engine +matches the version of the build files. This is an important consideration +to take when deciding what to choose as "stable" and "in-progress" engine. +These instructions are written assuming the engine and the build versions match. + What is the "stable" engine is up to you. It only refers to a build of the engine you know is at a good working state. When you are at a point the source is stable you can run `bootstrap.sh/bat` from the root. That will