Merge pull request #2051 from radixdlt/tweak/develop-default-branch

README and CHANGELOG updates for making `develop` the default branch

.github/pull_request_template.md

@@ -1,16 +1,12 @@
 > [!IMPORTANT]
 >
 > * Please read our [Contributing Guidelines](/CONTRIBUTING.md) before opening a PR.
-> * Before creating your PR, please ensure you read the [node branching strategy](https://github.com/radixdlt/babylon-node/blob/main/docs/branching-strategy.md), which is also used in this repository. The end result after completing the merge actions should be that `main <= release/XXX <= develop`, where `XXX` is the latest released protocol version. This ensures that we minimise merge conflicts, and that work doesn't go missing.
+> * Before creating your PR, please ensure you read the [node branching strategy](https://github.com/radixdlt/babylon-node/blob/main/docs/branching-strategy.md), which is also used in this repository. The end result after completing the merge actions should be that `release/XXX <= develop`, where `XXX` is the latest released protocol version. This ensures that we minimise merge conflicts, and that work doesn't go missing.
 > * As per the branching strategy, **you must ensure you select the _correct base branch_**, both for branching from, and in the PR UI above. The following process can be used to decide the base branch:
->   * For code changes which can wait until the next protocol update to be released, use `develop`. This should be the default for code changes.
->   * For code changes which need to go out as a fully-interoperable update to the node at the current protocol version, use `release/XXX`.
+>   * For README changes or code changes which can wait until the next protocol update to be released, use `develop`. This should be the default for code changes.
+>   * For github workflow changes, or code changes which need to go out as a fully-interoperable update to the node at the current protocol version, use `release/XXX`.
 >     * Such changes must be tested and reviewed more carefully to mitigate the risk of regression.
 >     * Once the change is merged, it is the merger's responsibility to ensure `release/XXX` is merged into the `develop` branch.
->   * For github workflow changes, use `main`.
->     * Once the change is merged, it is the merger's responsibility to ensure `main` is merged into both `release/XXX` and `develop`, so that the changes also apply to hotfixes, and to current development.
->   * For changes to README files, use `main`.
->     * Once the change is merged, it is the merger's responsibility to ensure `main` is merged into both `release/XXX` and `develop`, so that the changes also apply on these branches.
 > 
 > _Please remove this section once you confirm you follow its guidance._
 
@@ -30,17 +26,13 @@
 > Explain what testing / verification is done, including manual testing or automated testing.
 -->
 
-## Update Recommendations
+## Changelog
 <!--
-> [!NOTE]
-> 
-> This section is to provide recommendations to consumers of this repo about how they should handle breaking changes, or integrate new features.
-> 
-> If your PR contains no breaking changes or new features or hasn't been tagged, this whole section can be deleted. Add sub-headings if required for:
-> * ### Guidance for dApp Developers
->   * Migration recommendations for a dApp developer to update their dApp/integrations due to to the change/s in this PR. This should include renames and interface changes.
->   * Upon merge, please copy these instructions to an appropriate draft page under https://docs.radixdlt.com/main/scrypto/release_notes
-> * ### Guidance for Internal Integrators
->   * Instructions to any internal integrations (e.g. Node, Toolkit, Gateway, Ledger App) for how the changes may affect them and recommendations for how they should update to support this change.
+> [!TIP]
+>
+> If the change in your PR is a new feature, or could affect or break any users/integrators, including scrypto developers, dApp developers, transaction creators, or internal integrators, then it likely will need an update to the CHANGELOG.md file.
 >
+> After making any required updates, write either of these two:
+> * "The changelog has been updated to capture XX changes which affect XX"
+> * "The changelog was not updated because this change has no user-facing impact"
 -->

CHANGELOG.md

@@ -0,0 +1,72 @@
+<!--
+> The purpose of this document is to be turned into:
+> * Release Overviews (e.g. in github release notes or Discord/email announcements)
+> * Detailed developer-facing release notes, to assist developers upgrading their scrypto or other integrations to the new version.
+>
+> It should be grouped by:
+> # Protocol Update
+> ## Version (Minor or patch)
+> ### Subsections: Major Features | Breaking changes | Other changes
+> 
+> A new release should contain the following:
+
+> [!NOTE]
+> 
+> This release is under development.
+
+### Major Features
+
+> Headline features that might be called out in the release overviews
+
+* *Pending...*
+
+### Breaking changes
+
+> Changes which may cause compilation errors for Scrypto developers or other integrators
+
+* *Pending...*
+
+### Other changes
+
+> Other incidental features or changes which shouldn't break existing integrations, but are worthy of mention to scrypto developers, dApp developers or other integrators.
+
+* *Pending...*
+
+-->
+
+# v1.4.x - [Dugong](https://docs.radixdlt.com/docs/dugong)
+
+## v1.4.0
+
+> [!NOTE]
+> 
+> This release is under development.
+
+### Major Features
+
+> Headline features that might be called out in the release overviews
+
+* *Pending...*
+
+### Breaking changes
+
+> Changes which may cause compilation errors for Scrypto developers or other integrators
+
+* [#2035](https://github.com/radixdlt/radixdlt-scrypto/pull/2035) - types specifying multiple types in `#[sbor(categorize_types = "S, T")]` should now use a semi-colon as a separator: `#[sbor(categorize_types = "S; T")]`
+* [#2017](https://github.com/radixdlt/radixdlt-scrypto/pull/2017) - Manual implementations of `ContextualDisplay` must now take a `&mut fmt::Formatter` instead of a `F: fmt::Write`.
+
+### Other changes
+
+> Other incidental features or changes which shouldn't break existing integrations, but are worthy of mention to scrypto developers, dApp developers or other integrators.
+
+* *Pending...*
+
+# v1.3.x - [Cuttlefish](https://docs.radixdlt.com/docs/cuttlefish)
+
+## v1.3.0
+
+We didn't have a formal changelog. Please see the [protocol updates](https://docs.radixdlt.com/docs/protocol-updates) section of the docs site for more information.
+
+# v1.2.x - [Bottlenose](https://docs.radixdlt.com/docs/bottlenose) and before
+
+We didn't have a formal changelog. Please see the [protocol updates](https://docs.radixdlt.com/docs/protocol-updates) section of the docs site for more information.

README.md

@@ -1,10 +1,17 @@
-# Scrypto
+# Scrypto / Radix Engine
 
 [![CI](https://github.com/radixdlt/radixdlt-scrypto/actions/workflows/ci.yml/badge.svg)](https://github.com/radixdlt/radixdlt-scrypto/actions/workflows/ci.yml)
 
-Language for building DeFi apps on Radix.
+This repository includes the source for:
+* The **[Scrypto](./scrypto)** language ([guide](https://docs.radixdlt.com/docs/scrypto-1)) - The language for building DeFi apps on Radix. See the below section for getting started with Scrypto.
+* The **[Radix Engine](./radix-engine)** ([reference](https://docs.radixdlt.com/docs/engine-tech-docs)) - The execution environment for transactions in the Radix network, used by the [babylon-node](https://github.com/babylon-node).
 
-Documentation: https://docs.radixdlt.com/docs/scrypto-1
+It also includes various supporting crates ([guide](https://docs.radixdlt.com/docs/rust-libraries-overview)), such as:
+* [radix-transactions](./radix-transactions/) ([guide](https://docs.radixdlt.com/docs/rust-libraries-overview) | [docs.rs](https://docs.rs/radix-transactions/latest/radix_transactions/)) - The transaction models and transaction builders for constructing transactions and subintents for pre-authorizations.
+* [radix-common](./radix-common) ([docs.rs](https://docs.rs/radix-common/latest/radix_common/)) - Various Radix types, used across the stack.
+* [radix-rust](./radix-rust) ([docs.rs](https://docs.rs/radix-rust/latest/radix_rust/)) - Various common abstractions/utilities built on top of the `core` library, enabling some libraries to run in `no-std` environments
+* [sbor](./sbor/) ([reference](https://docs.radixdlt.com/docs/what-is-sbor)) - The tagged, verifiable encoding format used by the Radix engine.
+* [clis](./radix-clis) ([guide](https://docs.radixdlt.com/docs/tools-for-scrypto) | [docs.rs](https://docs.rs/radix-clis/latest/radix_clis/)) - Various developer CLIs to support dApp development.
 
 ## Scrypto Development
 
@@ -17,6 +24,12 @@ Documentation: https://docs.radixdlt.com/docs/scrypto-1
   - [`scrypto`](https://docs.radixdlt.com/docs/scrypto-cli-tool)
   - [`resim`](https://docs.radixdlt.com/docs/resim-radix-engine-simulator)
 
+## Branching
+
+The default branch for this repository is `develop`, which typically includes unreleased code.
+
+To look at the currently live code, use the corresponding release tag or `release/<protocol-update>` branch for the correct [protocol update](https://docs.radixdlt.com/docs/protocol-updates).
+
 ## Contribute
 
 To learn more about how to contribute to this project, read the [Contributing Guide](./CONTRIBUTING.md).