From 319efa83dfbde6e20cddf23a7a1965afeb8cd881 Mon Sep 17 00:00:00 2001 From: "sweep-ai[bot]" <128439645+sweep-ai[bot]@users.noreply.github.com> Date: Thu, 1 Feb 2024 14:34:15 +0000 Subject: [PATCH 1/3] feat: Updated CONTRIBUTING.md --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d34c003d90b..7ae392d8e64 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,6 +23,8 @@ contributions. Please follow our README for [instructions on installing from source](https://github.com/timescale/timescaledb/blob/main/README.md#option-3---from-source). +Ensure that you have the necessary dependencies installed and configured before building TimescaleDB. + ## Style guide Before submitting any contributions, please ensure that it adheres to @@ -115,9 +117,9 @@ open a pull request**. If you are running locally: ```bash # Use Debug build mode for full battery of tests -./bootstrap -DCMAKE_BUILD_TYPE=Debug +./bootstrap cd build && make -make installcheck +cd build && make installcheck ``` All submitted pull requests are also automatically From b49f0c77c32873e0db99c84f4fb7b9a3b26db545 Mon Sep 17 00:00:00 2001 From: "sweep-ai[bot]" <128439645+sweep-ai[bot]@users.noreply.github.com> Date: Thu, 1 Feb 2024 14:34:47 +0000 Subject: [PATCH 2/3] feat: Updated CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7ae392d8e64..812301189ab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -95,7 +95,7 @@ our [Style Guide](docs/StyleGuide.md). request, either mention them (preferably by GitHub name) in the PR's body or [assign them as a reviewer](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/). - * If you get a test failure in the CI, check them under [Github Actions](https://github.com/timescale/timescaledb/actions) + * To check the build status of the repository and identify any test failures, navigate to [Github Actions](https://github.com/timescale/timescaledb/actions) * Address feedback by amending your commit(s). If your change contains multiple commits, address each piece of feedback by amending that @@ -117,7 +117,7 @@ open a pull request**. If you are running locally: ```bash # Use Debug build mode for full battery of tests -./bootstrap +make bootstrap cd build && make cd build && make installcheck ``` From d6f06373019aafd6e8e9a0fd57ee53fb7b53020b Mon Sep 17 00:00:00 2001 From: "sweep-ai[bot]" <128439645+sweep-ai[bot]@users.noreply.github.com> Date: Thu, 1 Feb 2024 14:38:50 +0000 Subject: [PATCH 3/3] Revert CONTRIBUTING.md --- CONTRIBUTING.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 812301189ab..c5f06665492 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,6 +14,9 @@ begin discussion on the GitHub issues page. This is the best place to discuss your proposed improvement (and its implementation) with the core development team. +cd timescaledb +# Add the build/ directory to the repository + Before we accept any code contributions, Timescale contributors need to sign the [Contributor License Agreement](https://cla-assistant.io/timescale/timescaledb) (CLA). By signing a CLA, we can ensure that the community is free and confident in its ability to use your @@ -23,13 +26,14 @@ contributions. Please follow our README for [instructions on installing from source](https://github.com/timescale/timescaledb/blob/main/README.md#option-3---from-source). -Ensure that you have the necessary dependencies installed and configured before building TimescaleDB. - ## Style guide Before submitting any contributions, please ensure that it adheres to our [Style Guide](docs/StyleGuide.md). +cd timescaledb +# Add the build/ directory to the repository + ## Code review workflow * Sign the [Contributor License Agreement](https://cla-assistant.io/timescale/timescaledb) (CLA) if you're a new contributor. @@ -95,7 +99,7 @@ our [Style Guide](docs/StyleGuide.md). request, either mention them (preferably by GitHub name) in the PR's body or [assign them as a reviewer](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/). - * To check the build status of the repository and identify any test failures, navigate to [Github Actions](https://github.com/timescale/timescaledb/actions) + * If you get a test failure in the CI, check them under [Github Actions](https://github.com/timescale/timescaledb/actions) * Address feedback by amending your commit(s). If your change contains multiple commits, address each piece of feedback by amending that @@ -117,9 +121,15 @@ open a pull request**. If you are running locally: ```bash # Use Debug build mode for full battery of tests -make bootstrap + +# Build the project in Debug mode +cd timescaledb +cmake -DCMAKE_BUILD_TYPE=Debug . +make +cd .. +./bootstrap -DCMAKE_BUILD_TYPE=Debug cd build && make -cd build && make installcheck +make installcheck ``` All submitted pull requests are also automatically