Skip to content

Commit c914cdb

Browse files
authored
Merge pull request #28 from jketema/explain-next
Explain the purpose of the `next` branch
2 parents 66feebe + 707e5cd commit c914cdb

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/development_handbook.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
| 0.22.0 | 2022-07-05 | Remco Vermeulen | Update section `Generation of query templates from rule specifications` to include external help files. |
3131
| 0.23.0 | 2022-07-05 | Remco Vermeulen | Update text to consider both the C++ and the C standards. |
3232
| 0.24.0 | 2022-07-05 | Remco Vermeulen | Update release process to include steps for external help files. |
33+
| 0.25.0 | 2022-07-22 | Jeroen Ketema | Document the existence and purpose of the `next` branch. |
3334

3435
## Scope of work
3536

@@ -605,6 +606,10 @@ All software development processes associated with this repository should be doc
605606

606607
Requirements and project planning are maintained separately within an internal repository at GitHub.
607608

609+
### Purpose ot the `next` branch
610+
611+
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.
612+
608613
## Task Automation
609614

610615
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`.

0 commit comments

Comments
 (0)