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

summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorLeitwolf112026-11-13 17:23:57 +0300
committerLeitwolf112026-11-13 17:23:57 +0300
commite0d6a8c15bf123862daeb40e5cdd32e6f2f67045 (patch)
tree16dece5f9af32d3431694fe1228fdaecb8d05c18
parentc9e8341743979c367676b4355c0be1eea8bee211 (diff)
downloadprogmasoft-cpp-e0d6a8c15bf123862daeb40e5cdd32e6f2f67045.tar.gz
Name the guide Progmasoft Core C++ Coding Guidelines
The README, ADOPTING, CONTRIBUTING and the license texts use the new name, matching its directory; the changelog records that it was Progmasoft C++ Style. Earlier changelog entries keep the name they had. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
-rw-r--r--ADOPTING.md4
-rw-r--r--CHANGELOG.md2
-rw-r--r--CONTRIBUTING.md2
-rw-r--r--LICENSE.md4
-rw-r--r--LICENSES/CC0-1.0.md2
-rw-r--r--README.md7
6 files changed, 12 insertions, 9 deletions
diff --git a/ADOPTING.md b/ADOPTING.md
index 19667c3..36d1359 100644
--- a/ADOPTING.md
+++ b/ADOPTING.md
@@ -3,7 +3,7 @@
# Adopting the guide
-A project adopts Progmasoft C++ Style by pointing to it, copying its two tool profiles and writing down, once, where it
+A project adopts Progmasoft Core C++ Coding Guidelines by pointing to them, copying its two tool profiles and writing down, once, where it
deviates.
## 1. Point to the guide
@@ -13,7 +13,7 @@ Add a short section to the project's contributing guide:
```markdown
## C++ style
-C++ code follows [Progmasoft C++ Style](https://github.com/Progmasoft/progmasoft-cpp).
+C++ code follows [Progmasoft Core C++ Coding Guidelines](https://github.com/Progmasoft/progmasoft-cpp).
`clang-format` and `clang-tidy` enforce what they can; review covers the rest.
Deviations of this project are listed below.
```
diff --git a/CHANGELOG.md b/CHANGELOG.md
index ddd82cc..82bc430 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,8 @@ A revision of the guide is named by its date. A change that requires existing co
## Unreleased
+The guide is named Progmasoft Core C++ Coding Guidelines; it was Progmasoft C++ Style.
+
The guide 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;
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b718214..b3c67ee 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -3,7 +3,7 @@
# Contributing
-Progmasoft C++ Style changes when a rule turns out to be wrong, unclear or missing. Proposals are welcome from anyone,
+Progmasoft Core C++ Coding Guidelines change when a rule turns out to be wrong, unclear or missing. Proposals are welcome from anyone,
whether or not they work on a Progmasoft project.
## Proposing a change
diff --git a/LICENSE.md b/LICENSE.md
index 85332f3..972cb9f 100644
--- a/LICENSE.md
+++ b/LICENSE.md
@@ -5,12 +5,12 @@
Copyright 2026 Progmasoft.
-The text of Progmasoft C++ Style is licensed under the
+The text of Progmasoft Core C++ Coding Guidelines is licensed under the
[Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/) (CC BY 4.0).
You may share and adapt it for any purpose, including commercially, as long as you give appropriate credit, link to
the license and say whether you changed it. A credit line such as this one is enough:
-> Based on [Progmasoft C++ Style](https://github.com/Progmasoft/progmasoft-cpp), CC BY 4.0.
+> Based on [Progmasoft Core C++ Coding Guidelines](https://github.com/Progmasoft/progmasoft-cpp), CC BY 4.0.
**Configuration and code examples are dedicated to the public domain** under
[CC0 1.0 Universal](LICENSES/CC0-1.0.md). This covers every fenced code block in this repository: the `.clang-format`
diff --git a/LICENSES/CC0-1.0.md b/LICENSES/CC0-1.0.md
index 0049aa0..56a0f38 100644
--- a/LICENSES/CC0-1.0.md
+++ b/LICENSES/CC0-1.0.md
@@ -3,7 +3,7 @@
# CC0 1.0 Universal
-The configuration and code examples of Progmasoft C++ Style are dedicated to the public domain under this legal code;
+The configuration and code examples of Progmasoft Core C++ Coding Guidelines are dedicated to the public domain under this legal code;
see [LICENSE.md](../LICENSE.md).
```text
diff --git a/README.md b/README.md
index 238446b..433f344 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,11 @@
<!-- SPDX-FileCopyrightText: 2026 Progmasoft <support@progmasoft.com> -->
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
-# Progmasoft C++ Style
+# Progmasoft Core C++ Coding Guidelines
-Progmasoft C++ Style is a style guide for C++17 and C++20. It says how code is named, laid out, structured and checked, and why,
-so that a reader can move between files and projects without relearning the conventions each time.
+Progmasoft Core C++ Coding Guidelines are the coding guidelines of Progmasoft for C++17 and C++20. They say how code
+is named, laid out, structured and checked, and why, so that a reader can move between files and projects without
+relearning the conventions each time.
It is written for anyone who wants a complete, opinionated rule set to adopt. Progmasoft's own C++ projects follow it,
among them the [Tala compiler](https://github.com/Progmasoft/tala) and [Catch3](https://github.com/Progmasoft/catch3).