From ef9bcbd58628b407dbd9dc054dad8dc00b66463b Mon Sep 17 00:00:00 2001 From: Jeroen Ketema Date: Fri, 22 Jul 2022 15:31:56 +0200 Subject: [PATCH 1/2] Explain the purpose of the `next` branch --- docs/development_handbook.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/development_handbook.md b/docs/development_handbook.md index d00e9f3d2a..f1bba2cdb5 100644 --- a/docs/development_handbook.md +++ b/docs/development_handbook.md @@ -30,6 +30,7 @@ | 0.22.0 | 2022-07-05 | Remco Vermeulen | Update section `Generation of query templates from rule specifications` to include external help files. | | 0.23.0 | 2022-07-05 | Remco Vermeulen | Update text to consider both the C++ and the C standards. | | 0.24.0 | 2022-07-05 | Remco Vermeulen | Update release process to include steps for external help files. | +| 0.25.0 | 2022-07-22 | Jeroen Ketema | Document the existence and purpose of the `next` branch. | ## Scope of work @@ -605,6 +606,10 @@ All software development processes associated with this repository should be doc Requirements and project planning are maintained separately within an internal repository at GitHub. +### Purpose ot the `next` branch + +This git repository also has a [`next` branch](https://github.com/github/codeql-coding-standards/tree/next). The purpose of this branch is to track changes that that will become necessary when upgrading the CodeQL external dependencies as described in section _Upgrading external dependencies_. The changes on the `next` branch will undergo only light reviewing. As such, a full review as described in section _Code review and automated checks_ is required when merging these changes in `main`, and no releases should be made from the `next` branch. We do aim the changes on the `next` branch to be as complete as possible to make merging into `main` as straightforward as possible. + ## Task Automation In the `.vscode` directory this repository comes with a `tasks.json` file which automates some of the tasks described in this document. To access them, in VSCode use `Ctrl+Shift+P` and select `Run Task`. From 707e5cddf0581dbf694ba8caecd70111e5b32466 Mon Sep 17 00:00:00 2001 From: Jeroen Ketema <93738568+jketema@users.noreply.github.com> Date: Fri, 22 Jul 2022 16:38:17 +0200 Subject: [PATCH 2/2] Update docs/development_handbook.md Co-authored-by: John L. Singleton --- docs/development_handbook.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development_handbook.md b/docs/development_handbook.md index f1bba2cdb5..10de0401a7 100644 --- a/docs/development_handbook.md +++ b/docs/development_handbook.md @@ -608,7 +608,7 @@ Requirements and project planning are maintained separately within an internal r ### Purpose ot the `next` branch -This git repository also has a [`next` branch](https://github.com/github/codeql-coding-standards/tree/next). The purpose of this branch is to track changes that that will become necessary when upgrading the CodeQL external dependencies as described in section _Upgrading external dependencies_. The changes on the `next` branch will undergo only light reviewing. As such, a full review as described in section _Code review and automated checks_ is required when merging these changes in `main`, and no releases should be made from the `next` branch. We do aim the changes on the `next` branch to be as complete as possible to make merging into `main` as straightforward as possible. +This git repository also has a [`next` branch](https://github.com/github/codeql-coding-standards/tree/next). The purpose of this branch is to track changes that that will become necessary when upgrading the CodeQL external dependencies as described in section _Upgrading external dependencies_. The changes on the `next` branch will undergo only light reviewing. As such, a full review as described in section _Code review and automated checks_ is required when merging these changes into `main`; no releases should be made from the `next` branch. We aim to ensure that the changes on the `next` branch are as complete as possible so that merging into `main` will be straightforward. ## Task Automation