Documentation
README
Branch handling
If on main, checkout a new branch first.
If on a non-main branch where the existing PR is already merged, the uncommitted changes are likely unrelated to that branch. In this case:
- Checkout main and pull
- Create a new branch with a name describing the uncommitted changes
- Continue with the commit workflow below
Commit workflow
Stage and commit ALL the changes in the git repo (not just the ones in this session). Use gh cli to check if a PR exists for this branch. If no PR exists, create one with an appropriate title and description. If a PR exists, query its current title and description and update them if the new changes warrant it. Push the changes.
This is the opening of the README. Read the full README on GitHub.