From 7b3da807f529caa38ee96ec82bf81e25e22da825 Mon Sep 17 00:00:00 2001 From: Pieter Viljoen Date: Thu, 15 Jan 2026 16:52:40 -0800 Subject: [PATCH 1/2] Improve README for clarity and consistency in setup instructions Signed-off-by: Pieter Viljoen --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0963f920..236f3c8c 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,8 @@ Packages published on [NuGet](https://www.nuget.org/packages/ptr727.ProjectTempl ### Tools Setup -- Install VSCode and / or Visual Studio +- Install Visual Studio Code. +- Install Visual Studio. ### Git Setup @@ -97,15 +98,15 @@ Packages published on [NuGet](https://www.nuget.org/packages/ptr727.ProjectTempl ### GitHub Local Actions Setup -- Install [ACT](https://nektosact.com/installation/index.html): +- Install [Nektos ACT](https://nektosact.com/): ```shell winget install nektos.act winget upgrade nektos.act ``` -- Install [VSCode extension](https://sanjulaganepola.github.io/github-local-actions-docs/). -- Update [settings](https://nektosact.com/usage/index.html#action-artifacts) to start the artifact server. +- Install [GitHub Local Actions](https://marketplace.visualstudio.com/items?itemName=SanjulaGanepola.github-local-actions) Visual Studio Code extension. +- Update [settings](https://nektosact.com/usage/index.html#action-artifacts) to always start the artifact server. ```json "githubLocalActions.actCommand": "act --artifact-server-path ./.artifacts", @@ -135,7 +136,7 @@ Packages published on [NuGet](https://www.nuget.org/packages/ptr727.ProjectTempl - Default branch: `main` - Pull requests: - `Allow squash merging` - - [TODO:](https://github.com/orgs/community/discussions/184410): Disable merge and rebase merging, ruleset merge rules do not work. + - [TODO:](https://github.com/orgs/community/discussions/184410): Disable merge and rebase merging, ruleset merge rules do not currently work. - `Always suggest updating pull request branches` - `Allow auto-merge` - Rules / Rulesets: @@ -160,10 +161,11 @@ Packages published on [NuGet](https://www.nuget.org/packages/ptr727.ProjectTempl ## Branching Workflow - Create persistent `main` and `develop` branches. -- Make sure that `main` and `develop` are always building. +- Protect `main` and `develop` branches with [branch protection rules](#github-project-settings). +- Make sure that `main` and `develop` are always building error free. - Create feature branches from the `develop` branch. -- Always "Squash and merge" from feature branches to `develop` to reduce the history size. -- Always "Merge commit" from `develop` to `main` to retain merge history. +- Always "Squash and merge" from feature branches to the `develop` branch to minimize changes history. +- Always "Squash and merge" from `develop` to `main` to retain linear merge history. ## GitHub Actions Workflow From f7e95c32a1b985d304dc367667a74264524a6735 Mon Sep 17 00:00:00 2001 From: Pieter Viljoen Date: Thu, 15 Jan 2026 16:57:22 -0800 Subject: [PATCH 2/2] Clarify merge strategy in README to emphasize maintaining linear history Signed-off-by: Pieter Viljoen --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 236f3c8c..343dc005 100644 --- a/README.md +++ b/README.md @@ -164,8 +164,8 @@ Packages published on [NuGet](https://www.nuget.org/packages/ptr727.ProjectTempl - Protect `main` and `develop` branches with [branch protection rules](#github-project-settings). - Make sure that `main` and `develop` are always building error free. - Create feature branches from the `develop` branch. -- Always "Squash and merge" from feature branches to the `develop` branch to minimize changes history. -- Always "Squash and merge" from `develop` to `main` to retain linear merge history. +- Always "Squash and merge" from feature branches to the `develop` branch to minimize change history. +- Always "Squash and merge" from `develop` to `main` to maintain a linear history. ## GitHub Actions Workflow