From 29a7331cf4a62e5b0559bf7f0817bf2075530ca8 Mon Sep 17 00:00:00 2001 From: epoberezkin Date: Mon, 26 Oct 2026 10:35:19 +0000 Subject: [PATCH] deploy: c3b709a80748ef3594dfb4f98bdfc51d6e4d727f --- docs/contributing.html | 17 ++++++++++------- docs/contributing.md | 20 ++++++++++---------- 2 files changed, 20 insertions(+), 17 deletions(-) diff --git a/docs/contributing.html b/docs/contributing.html index 68bf526643..9e95b1f742 100644 --- a/docs/contributing.html +++ b/docs/contributing.html @@ -1037,13 +1037,7 @@ window.addEventListener('click',(e)=>{

Follow project structure, coding style and approaches

./contributing/PROJECT.md has information about the structure of this simplex-chat repository.

./contributing/CODE.md has details about general requirements common for simplexmq and simplex-chat repositories.

-

These files can be used with LLM prompts, e.g. if you use Claude Code you can create CLAUDE.md file in project root importing content from these files:

-
@README.md
-@docs/CONTRIBUTING.md
-@docs/contributing/PROJECT.md
-@docs/contributing/CODE.md
-
-

For Android/Desktop and iOS apps you can additionally import apps/multiplatform/README.md and apps/ios/README.md.

+

CLAUDE.md in the repository root imports these files, this guide and ../scripts/ci/README.md for Claude Code; apps/ios/CLAUDE.md and apps/multiplatform/CLAUDE.md import the README of each app.

Compiling with SQLCipher encryption enabled

Add cabal.project.local to project root with the location of OpenSSL headers and libraries and flag setting encryption mode:

cp scripts/cabal.project.local.mac cabal.project.local
@@ -1103,6 +1097,15 @@ window.addEventListener('click',(e)=>{
 
 
We squash PRs, do not rewrite branch history after the review.

 
For some complex features we create feature branches that will be merged once ready - do not make commits directly to them, make PRs to feature branches.

+
Pull requests and CI

+
    
+
  1. Open a pull request to master as a draft. On a draft, CI runs the reduced build: one Linux job that builds and tests the changed scopes, and one macOS job only when iOS code changed (CI guide: scripts/ci/README.md).
    2. 
+
  2. Select the core tests in a ci-tests block in the description, one hspec match pattern per line. / runs all tests; without a block, the reduced build runs no core tests.
    3. 
+
  3. Push the changes for review comments to the same branch; each push runs the reduced build.
    4. 
+
  4. Reviewers approve the draft. A draft cannot be merged.
    5. 
+
  5. After the approval, mark the pull request ready for review. CI then runs the full matrix, and the pull request is merged by squash once it passes.
    6. 
+
  6. A change to a scope without CI tests adds its build and tests to CI in the same pull request.
    7. 
+

 
Differences between GHC 8.10.7 and GHC 9.6.3

 
    
 
  1. The main difference is related to DuplicateRecordFields extension.
    2. 
diff --git a/docs/contributing.md b/docs/contributing.md
index 06fa1426d8..a83fc01a8b 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -16,16 +16,7 @@ Please discuss the problem you want to solve and your detailed implementation pl
 
 ./contributing/CODE.md has details about general requirements common for `simplexmq` and `simplex-chat` repositories.
 
-These files can be used with LLM prompts, e.g. if you use Claude Code you can create CLAUDE.md file in project root importing content from these files:
-
-```markdown
-@README.md
-@docs/CONTRIBUTING.md
-@docs/contributing/PROJECT.md
-@docs/contributing/CODE.md
-```
-
-For Android/Desktop and iOS apps you can additionally import `apps/multiplatform/README.md` and `apps/ios/README.md`.
+CLAUDE.md in the repository root imports these files, this guide and ../scripts/ci/README.md for Claude Code; apps/ios/CLAUDE.md and apps/multiplatform/CLAUDE.md import the README of each app.
 
 ## Compiling with SQLCipher encryption enabled
 
@@ -89,6 +80,15 @@ We squash PRs, do not rewrite branch history after the review.
 
 For some complex features we create feature branches that will be merged once ready - do not make commits directly to them, make PRs to feature branches.
 
+## Pull requests and CI
+
+1. Open a pull request to `master` as a draft. On a draft, CI runs the reduced build: one Linux job that builds and tests the changed scopes, and one macOS job only when iOS code changed (CI guide: scripts/ci/README.md).
+2. Select the core tests in a `ci-tests` block in the description, one hspec match pattern per line. `/` runs all tests; without a block, the reduced build runs no core tests.
+3. Push the changes for review comments to the same branch; each push runs the reduced build.
+4. Reviewers approve the draft. A draft cannot be merged.
+5. After the approval, mark the pull request ready for review. CI then runs the full matrix, and the pull request is merged by squash once it passes.
+6. A change to a scope without CI tests adds its build and tests to CI in the same pull request.
+
 ## Differences between GHC 8.10.7 and GHC 9.6.3
 
 1. The main difference is related to `DuplicateRecordFields` extension.