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

summaryrefslogtreecommitdiffhomepage
path: root/ADOPTING.md
diff options
context:
space:
mode:
authorLeitwolf112026-11-13 17:38:17 +0300
committerLeitwolf112026-11-13 17:38:17 +0300
commitaabd11c1321da173918ad48a2ffb7da5e6d90756 (patch)
tree12e428e1f7bdf1f3173842f9e4e84a53ce3a39bb /ADOPTING.md
parent98e0e3d6fbde5fd5634e38ea5cc143da688545a0 (diff)
downloadprogmasoft-cpp-docs/guidelines-layout.tar.gz
Use the two names consistentlydocs/guidelines-layout
Progmasoft C/C++ Styles names the repository, where a text speaks of all of it: the README introduction, the license texts, CONTRIBUTING and the changelog. Progmasoft Core C++ Coding Guidelines names its C++ guide, and its own documents call it "the guidelines", in the plural like its name, instead of "the guide" or "this guide"; the verbs follow. Dated changelog entries keep their wording. Paragraphs that grew past 120 columns are rewrapped; every link and anchor still resolves. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Diffstat (limited to 'ADOPTING.md')
-rw-r--r--ADOPTING.md28
1 files changed, 15 insertions, 13 deletions
diff --git a/ADOPTING.md b/ADOPTING.md
index 38d4cc6..5c1112e 100644
--- a/ADOPTING.md
+++ b/ADOPTING.md
@@ -1,12 +1,12 @@
<!-- SPDX-FileCopyrightText: 2026 Progmasoft <support@progmasoft.com> -->
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
-# Adopting the guide
+# Adopting Progmasoft Core C++ Coding Guidelines
A project adopts Progmasoft Core C++ Coding Guidelines by pointing to them, copying their two tool profiles and
writing down, once, where it deviates.
-## 1. Point to the guide
+## 1. Point to the guidelines
Add a short section to the project's contributing guide:
@@ -18,11 +18,12 @@ C++ code follows [Progmasoft Core C++ Coding Guidelines](https://github.com/Prog
Deviations of this project are listed below.
```
-Do not copy the rules into the project. A copy drifts from the guide, and two documents that disagree are worse than
-one.
+Do not copy the rules into the project. A copy drifts from the guidelines, and two documents that disagree are worse
+than one.
-State the language version in the same section, C++20 or C++17; [the guide says how to choose](Progmasoft_Core_Cpp_Coding_Guidelines/Common/LANGUAGE.md), and
-the project follows the page of its version ([C++20](Progmasoft_Core_Cpp_Coding_Guidelines/Cpp20/LANGUAGE.md),
+State the language version in the same section, C++20 or C++17; [the guidelines say how to
+choose](Progmasoft_Core_Cpp_Coding_Guidelines/Common/LANGUAGE.md), and the project follows the page of its version
+([C++20](Progmasoft_Core_Cpp_Coding_Guidelines/Cpp20/LANGUAGE.md),
[C++17](Progmasoft_Core_Cpp_Coding_Guidelines/Cpp17/LANGUAGE.md)).
## 2. Copy the profiles
@@ -34,7 +35,8 @@ the project follows the page of its version ([C++20](Progmasoft_Core_Cpp_Coding_
| compiler flags | [Tooling: flags](Progmasoft_Core_Cpp_Coding_Guidelines/Common/TOOLING.md#flags), in the build files of the project |
The profiles are in the public domain (see [LICENSE.md](LICENSE.md)), so they can be copied under the project's own
-license. Note the guide revision they come from in a comment at the top of each file, so a later update can be compared.
+license. Note the revision of the guidelines they come from in a comment at the top of each file, so a later update can
+be compared.
## 3. Record the deviations
@@ -50,16 +52,16 @@ use exceptions because its host does. List them in the contributing guide, each
(Errors, 7.1).
```
-Within the project, its documented rule wins over the guide. An undocumented difference is not a deviation; it is code
-that has not caught up yet.
+Within the project, its documented rule wins over the guidelines. An undocumented difference is not a deviation; it is
+code that has not caught up yet.
## 4. Converge gradually
-Existing code is not rewritten in one sweep. A file follows the guide where it is changed. A purely mechanical change,
-such as applying `clang-format` to a directory or renaming a member convention, is its own pull request, never mixed
-with a change in behavior, so that review and `git blame` stay useful.
+Existing code is not rewritten in one sweep. A file follows the guidelines where it is changed. A purely mechanical
+change, such as applying `clang-format` to a directory or renaming a member convention, is its own pull request, never
+mixed with a change in behavior, so that review and `git blame` stay useful.
-## Projects that follow the guide
+## Projects that follow the guidelines
| Project | Deviations recorded in |
| --- | --- |