Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/CHANGELOG.md
blob: e3921095e216e8bf5e9157c04b86f3d56a07dbe3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
<!-- SPDX-FileCopyrightText: 2026 Progmasoft <[email protected]> -->
<!-- SPDX-License-Identifier: CC-BY-4.0 -->

# Changelog

A revision of Progmasoft C/C++ Styles is named by its date. A change that requires existing code to change says so.

## Unreleased

Progmasoft Core C Coding Guidelines are written, for C11 with LLVM 23, in
`Progmasoft_Core_C_Coding_Guidelines/C11/`: eleven chapters, a `.clang-format` and a `.clang-tidy` profile, and an
`index.json`. They are a style of their own; the C interfaces of C++ libraries keep following the C++ guidelines.

`index.json` names its JSON Schema,
[schemastore.progmasoft.com/json/progmasoft-cpp-index.json](https://schemastore.progmasoft.com/json/progmasoft-cpp-index.json),
in `$schema`; editors check the file against it.

The former C++17 component guidelines folder is removed.

Naming 3.4 no longer allows a short lowercase namespace for a heavily used data model: every namespace is
`PascalCase` under the project's root. A project that keeps such a namespace records it as a deviation (Adopting, 3).
The examples name Catch3's namespaces.

The repository is named Progmasoft C/C++ Styles, and its C++ guide Progmasoft Core C++ Coding Guidelines; both
were Progmasoft C++ Style.

The guidelines moved to `Progmasoft_Core_Cpp_Coding_Guidelines/`. `Common/` holds the thirteen chapters, which apply to
both versions; `Cpp20/` and `Cpp17/` hold what applies to one version: the rules that use C++20 features, and their
C++17 form with the checks a C++17 library needs. `index.json` lists every document with its chapter and versions. No
rule changed; links to `Guide/` move to `Progmasoft_Core_Cpp_Coding_Guidelines/Common/`.

The guidelines cover C++17 as well as C++20. A project picks one; C++20 stays the default, and C++17 is for libraries
meant for other people's projects. [The C++17 page](Progmasoft_Core_Cpp_Coding_Guidelines/Cpp17/LANGUAGE.md) lists the
C++17 form of each C++20 feature the guidelines use. Existing C++20 projects need no change.

## 2026-10-18

The first revision of Progmasoft C++ Style. It writes down the conventions of the Progmasoft C++ projects and decides
what they left open:

- thirteen chapters, from principles to tooling, with the `.clang-format` and `.clang-tidy` profiles and the compiler
  flags in full;
- guidance for adopting the guide and recording a project's deviations;
- the text under CC BY 4.0, the configuration and code examples under CC0 1.0.