From cc805349b7006ccc93802f4921d487582c423d6f Mon Sep 17 00:00:00 2001 From: Stephan Beyer Date: Sat, 26 Nov 2016 17:03:17 +0100 Subject: [PATCH 1/4] Introduce SNOWHOUSE_{MAJOR,MINOR,PATCH} macros, set to 3.0.0 Also let the preprocessor compute the SNOWHOUSE_VERSION string. --- snowhouse/macros.h | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/snowhouse/macros.h b/snowhouse/macros.h index 5f3a972..c94459d 100644 --- a/snowhouse/macros.h +++ b/snowhouse/macros.h @@ -2,7 +2,16 @@ #define SNOWHOUSE_MACROS_H // clang-format off -#define SNOWHOUSE_VERSION "2.1.0" +#define SNOWHOUSE_MAJOR 3 +#define SNOWHOUSE_MINOR 0 +#define SNOWHOUSE_PATCH 0 + +#define SNOWHOUSE_TOSTRING(x) #x +#define SNOWHOUSE_MACROTOSTRING(x) SNOWHOUSE_TOSTRING(x) +#define SNOWHOUSE_VERSION \ + SNOWHOUSE_MACROTOSTRING(SNOWHOUSE_MAJOR) "." \ + SNOWHOUSE_MACROTOSTRING(SNOWHOUSE_MINOR) "." \ + SNOWHOUSE_MACROTOSTRING(SNOWHOUSE_PATCH) #if __cplusplus > 199711L // Visual Studio (including 2013) does not support the noexcept keyword From 3183e2b2f9219e16458930ebc840e2a2ffbe7502 Mon Sep 17 00:00:00 2001 From: Stephan Beyer Date: Sat, 26 Nov 2016 16:47:37 +0100 Subject: [PATCH 2/4] Use semver 2.0.0 --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index b04c077..d9a7c42 100644 --- a/README.md +++ b/README.md @@ -483,6 +483,14 @@ As above, but only in debug builds. Assert that a test behaved as expected. Throw an exception and let our testing framework deal with the test failure. +## Versioning + +Snowhouse uses [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html) since +version 3.0.0. +The macros `SNOWHOUSE_MAJOR`, `SNOWHOUSE_MINOR` and `SNOWHOUSE_PATCH` are defined +accordingly and `SNOWHOUSE_VERSION` contains the version string. +Note that in prior versions `SNOWHOUSE_VERSION` was the only defined macro. + ## Responsibilities Snowhouse was originally developed as part of the [Igloo](//github.com/joakimkarlsson/igloo) From c5094e0c6415fffe80921e7bd637552256915dc4 Mon Sep 17 00:00:00 2001 From: Stephan Beyer Date: Sat, 26 Nov 2016 17:08:07 +0100 Subject: [PATCH 3/4] Output snowhouse version in example/main.cpp --- example/main.cpp | 2 ++ 1 file changed, 2 insertions(+) diff --git a/example/main.cpp b/example/main.cpp index 12d2fee..b2c1340 100644 --- a/example/main.cpp +++ b/example/main.cpp @@ -17,6 +17,8 @@ void StringizeTests(); int main() { + std::cout << "Spec for Snowhouse " SNOWHOUSE_VERSION << std::endl; + try { BasicAssertions(); From fa9485d3ab19d4782d44eac798360548e40e1801 Mon Sep 17 00:00:00 2001 From: Stephan Beyer Date: Sat, 8 Apr 2017 17:53:04 +0200 Subject: [PATCH 4/4] Add a Contributing section to README.md --- README.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d9a7c42..5a0abec 100644 --- a/README.md +++ b/README.md @@ -491,6 +491,25 @@ The macros `SNOWHOUSE_MAJOR`, `SNOWHOUSE_MINOR` and `SNOWHOUSE_PATCH` are define accordingly and `SNOWHOUSE_VERSION` contains the version string. Note that in prior versions `SNOWHOUSE_VERSION` was the only defined macro. +## Contributing + +The development of Snowhouse takes place on [GitHub](//github.com/banditcpp/snowhouse). + +Snowhouse is licensed under the Boost Software License. +See LICENSE_1_0.txt for further information. + +By making available code for inclusion into Snowhouse (e.g., by opening a +pull request on GitHub), you guarantee that the code is licensed under the +same license as Snowhouse. + +Please make sure to be consistent with the project's coding style. +The `.clang-format` file allows easy checking and implementation of the +coding style. + +C++ code should comply to C++98, C++03- and C++11. +Please use `__cplusplus` guards if you want to use language features of +a certain C++ version. + ## Responsibilities Snowhouse was originally developed as part of the [Igloo](//github.com/joakimkarlsson/igloo) @@ -500,6 +519,3 @@ It has been extracted to be usable in other contexts, for example, Snowhouse is maintained by [Stephan Beyer](//github.com/sbeyer) since [October 2016](//twitter.com/JHKarlsson/status/789332548799332352). - -Snowhouse is licensed under the Boost Software License. -See LICENSE_1_0.txt for further information.