Skip to content

Improve README for clarity and consistency in setup instructions #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ptr727 merged 2 commits into from
Jan 16, 2026
Merged

Improve README for clarity and consistency in setup instructions #17

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7b3da80
Improve README for clarity and consistency in setup instructions
ptr727 Jan 16, 2026
f7e95c3
Clarify merge strategy in README to emphasize maintaining linear history
ptr727 Jan 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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:
Expand All @@ -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 change history.
- Always "Squash and merge" from `develop` to `main` to maintain a linear history.

## GitHub Actions Workflow

Expand Down