From c510e561220e300072d31208265394cf96b20998 Mon Sep 17 00:00:00 2001 From: Johnny <9611008+johnnymatthews@users.noreply.github.com> Date: Wed, 17 Jul 2024 17:00:00 -0300 Subject: [PATCH] Clarify PR branch process. (#187) * Update README.md * Fixed TOC. --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 844327d2..ec6b643e 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ A straightforward command-line interface (CLI) tool to showcase how to perform b - [Text-based user interface](#text-based-user-interface) - [Programmatic mode](#programmatic-mode) - [Available functions](#available-functions) -- [Development](#development) +- [Development contributions](#development-contributions) - [Support](#support) - [License](#license) @@ -133,7 +133,13 @@ Options: For more CLI instructions, check out [docs.entropy.xyz/reference/cli](https://docs.entropy.xyz/reference/cli). -## Development +## Development contributions + +All changes to this repo should be based off the `dev` branch. The `main` branch should not be directly edited, unless a hotfix is necessary. All PRs should follow this workflow: + +```plaintext +feature_branch -> dev -> main +``` If you want to make changes to this CLI tool, you should install it by following these steps: