Skip to content

Commit 867f5ab

Browse files
committed
Cleanup for release
1 parent 359218e commit 867f5ab

File tree

6 files changed

+14
-10
lines changed

6 files changed

+14
-10
lines changed

.github/CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,12 @@ Consult existing code for examples.
2525
For the longest time, however, no one but me actually read them.
2626
When I contribute to other projects, I definitely try to have useful, clear commit messages and you should, too.*
2727
8. Run `clang-format` using the project's [.clang-format].
28-
9. Open a pull request against the develop branch of the main repository (which is the default).
28+
9. Run `clang-tidy` using the project's [.clang-tidy].
29+
10. Open a pull request against the develop branch of the main repository (which is the default).
2930
[Travis-CI] will test it against combinations of Linux (Ubuntu 14.04), MacOS, clang, and gcc, so ensure that your code compiles on both platforms with both compilers.
30-
10. All pull requests must pass [Travis-CI] and [AppVeyor] to be accepted.
31-
In particular, look at results from git whitespace checks (`git diff --check HEAD^`), [ClangFormat], [ClangTidy], [Valgrind], [Coverity], and [Codecov] .
32-
11. I will get to your change as soon as I can.
31+
11. All pull requests must pass [Travis-CI] and [AppVeyor] to be accepted.
32+
In particular, look at results from git whitespace checks (`git diff --check HEAD^`), [ClangFormat], [ClangTidy], [Valgrind], [Codecov], and [SonarCloud] .
33+
12. I will get to your change as soon as I can.
3334
Feel free to ping me on [Gitter] with any questions.
3435
You will receive proper credit for your contributions both in the code and any resulting scientific papers using the output of `git log --format='%aN | sort -u`.
3536

@@ -62,4 +63,4 @@ Most editors/IDEs have plugins for `clang-format` and `clang-tidy`.
6263
[Codecov]: https://codecov.io/support
6364
[Gitter]: https://gitter.im/acgetchell/CDT-plusplus
6465
[ClangTidy]: http://clang.llvm.org/extra/clang-tidy/index.html
65-
[Coverity]: https://scan.coverity.com/projects/acgetchell-cdt-plusplus
66+
[SonarCloud]: https://sonarcloud.io/dashboard?id=CDT-plusplus%3Adevelop

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
cmake_minimum_required(VERSION 3.8.2)
22

3-
project(CDT-plusplus VERSION 0.1.7 LANGUAGES CXX)
3+
project(CDT-plusplus VERSION 0.1.8 LANGUAGES CXX)
44

55
if(${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR})
66
message(FATAL_ERROR "Do not build in-source.

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ brew install ninja
7575
brew upgrade boost
7676
brew install eigen
7777
brew install tbb
78-
brew install cgal --with-eigen3 --with-lapack
78+
brew install cgal --with-eigen3 --with-qt
7979
~~~
8080

8181
On Ubuntu, you will need an updated versions of [Clang] or [gcc],
@@ -229,6 +229,8 @@ One of the [Travis-CI] jobs runs ClangTidy on all changed files.
229229

230230
Another runs [Valgrind]; be sure to look at the results to ensure you're not leaking memory.
231231

232+
More comprehensive static checking is done by [SonarCloud], also worth a look.
233+
232234
## Contributing
233235

234236
Please see [CONTRIBUTING.md](.github/CONTRIBUTING.md) and our [CODE_OF_CONDUCT.md](.github/CODE_OF_CONDUCT.md).
@@ -280,3 +282,4 @@ Please see [CONTRIBUTING.md](.github/CONTRIBUTING.md) and our [CODE_OF_CONDUCT.m
280282
[curl]: https://curl.haxx.se
281283
[.appveyor.yml]: https://github.com/acgetchell/CDT-plusplus/blob/master/.appveyor.yml
282284
[Codecov]: https://codecov.io
285+
[SonarCloud]: https://sonarcloud.io/dashboard?id=CDT-plusplus%3Adevelop

clang-tidy.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ rm -rf build/
44
mkdir build && cd build
55
# Export compilation database for run-clang-tidy.py
66
cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ..
7-
#`locate run-clang-tidy.py` -header-filter='.*' -checks='-*,cert*,clang*,cppcoreguidelines*,misc-assert*,misc-b*,misc-dangling*,misc-f*,misc-i*,misc-move-const*,misc-n*,misc-r*,misc-s*,misc-t*,misc-u*,misc-v*,modernize*,performance*' -fix
7+
# Settings for tests to run in .clang-tidy
88
`locate run-clang-tidy.py` -fix

sonar-project.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
sonar.projectKey=CDT-plusplus
22
sonar.projectName=Causal Dynamical Triangulations in C++ using CGAL
3-
sonar.projectVersion=0.1.7
3+
sonar.projectVersion=0.1.8
44

55
# Metadata for the project
66
sonar.links.homepage=https://github.com/acgetchell/CDT-plusplus

src/cdt.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ int main(int argc, char* const argv[])
8181
std::map<std::string, docopt::value> args =
8282
docopt::docopt(USAGE, {argv + 1, argv + argc},
8383
true, // print help message automatically
84-
"CDT 0.1.7"); // Version
84+
"CDT 0.1.8"); // Version
8585

8686
// Debugging
8787
// for (auto const& arg : args) {

0 commit comments

Comments
 (0)