Skip to content

chore: update setup steps #298

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
smlx merged 1 commit into from
Aug 21, 2026
Merged

chore: update setup steps #298

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 9 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,10 @@ Then push some code to main:
git remote add origin git@github.com:smlx/newproject.git
git add .
git commit -am 'chore: create repository from template'
git push -u origin main
```

Then customize the code for your repository:

1. Check out a new branch to set up the repo `git checkout -b setup main`

1. Update the code for your project:

* rename `cmd/go-cli-github` to `cmd/$YOUR_COMMAND`
Expand All @@ -81,9 +78,17 @@ Then customize the code for your repository:
```bash
git add .
git commit -am 'chore: update template for new project'
git push -u origin main
```

1. Open a test PR, ensure all checks go green, then merge the PR. If workflows aren't green, commit and push to the branch until they are.

```bash
git checkout -b setup main
git commit -m 'chore: test PR workflows' --allow-empty
git push -u origin setup
gh pr create --fill
```
1. Open a PR, wait until all the checks go green, then merge the PR.

Configure the repository:

Expand Down
Loading