Skip to content

Commit

Permalink
Explain Working with Feature Branches in README
Browse files Browse the repository at this point in the history
  • Loading branch information
alxlo committed Nov 15, 2024
1 parent f3325d4 commit b2a87dd
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This repository contains a very early work-in-progress version for the iSAQB Tra
toc::[]

== How to contribute or participate
Create an issue or a pull-request
Create an issue or a pull-request.

== How to use this repository

Expand Down Expand Up @@ -71,6 +71,36 @@ To unify upper/lowercase within the (EN) version, we use the _Chicago manual of

For a possible German (DE) version, don't use punctuation at the end of bullet-list items, unless on the end of sentences.

=== Working with Feature Branches

TIP: If you've already made changes before branching, use `git stash` and `git stash pop` to temporarily store them.

==== Quick Start

. For existing issues use `Issue-#<number>-<Short-Description>` as the branch name
. Create and switch to feature branch:
+
--
[source,shell]
----
git checkout main
git pull
git checkout -b Issue-#42-add-examples # or use your Git UI
----
--

. Make changes, commit and push
. Create pull request via GitHub web interface


==== Git UI Tools and Detailed Intructions

* Linux: https://sourcegit.dev/[SourceGit], https://www.gitkraken.com/[GitKraken]
* Windows/macOS: GitHub Desktop, VS Code
* All tools support basic branch & PR workflows
* GitHub guide: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests
* Git branching: https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging


== Maintainers

Expand Down

0 comments on commit b2a87dd

Please sign in to comment.