diff --git a/docs/contributing.html b/docs/contributing.html index 36120d6157..cbbb8f4840 100644 --- a/docs/contributing.html +++ b/docs/contributing.html @@ -880,33 +880,15 @@ window.addEventListener('scroll',changeHeaderBg);

stable-android - used to build stable Android core library with Nix (GHC 8.10.7) - only for Android armv7a.

  • -

    stable-ios - used to build stable iOS core library with Nix (GHC 8.10.7) – this branch should be the same as stable-android except Nix configuration files. Deprecated.

    -
  • -
  • -

    master - branch for beta version releases (GHC 9.6.3).

    -
  • -
  • -

    master-ghc8107 - branch for beta version releases (GHC 8.10.7). Deprecated.

    +

    master - branch for beta version releases (compatible with both GHC 9.6.3 and 8.10.7).

  • master-android - used to build beta Android core library with Nix (GHC 8.10.7) - only for Android armv7a.

  • -
  • -

    master-ios - used to build beta iOS core library with Nix (GHC 8.10.7). Deprecated.

    -
  • -
  • -

    windows-ghc8107 - branch for windows core library build (GHC 8.10.7). Deprecated?

    -
  • -

    master-ios and windows-ghc8107 branches should be the same as master-ghc8107 except Nix configuration files.

    In simplexmq repo

    Development & release process

      @@ -914,18 +896,14 @@ window.addEventListener('scroll',changeHeaderBg);

      Make PRs to master branch only for both simplex-chat and simplexmq repos.

    1. -

      If simplexmq repo was changed, to build mobile core libraries you need to merge its master branch into master-ghc8107 branch.

      -
    2. -
    3. To build core libraries for Android, iOS and windows:

    -
      +
      1. All libraries should be built from master branch, Android armv7a - from master-android branch.

      2. @@ -941,9 +919,23 @@ window.addEventListener('scroll',changeHeaderBg);
      3. master to master-android (and compile/update code)
      4. master-android to stable-android
      5. -
          +
          1. Independently, master branch of simplexmq repo should be merged to stable branch on stable releases.
          +

          Branches and PRs

          +

          Use change scope (or comma separated scopes) as the first word in the PR names, followed by the colon. Commit name itself should be lowercase, in present tense.

          +

          The PR names in simplex-chat repo are used in release notes, they should describe the solved problem and not the change. Possible PR scopes:

          +
            +
          • ios
          • +
          • android
          • +
          • desktop
          • +
          • core
          • +
          • docs
          • +
          • website
          • +
          • ci
          • +
          +

          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.

          Differences between GHC 8.10.7 and GHC 9.6.3

          1. The main difference is related to DuplicateRecordFields extension.