Branch names with dashes between the words

[duianto]

Most if not all branch names have used underscores between the words until level 42.

But in:
Name: rebase_onto
Level: 41
Difficulty: **

One of the branch names readme-update uses a dash between the words. The other branch wrong_branch uses an underscore.

When searching in this githug repository for readme-update, then two files are listed:

levels/rebase_onto.rb has 3 instances:

githug/levels/rebase_onto.rb

Line 22 in 2544b01

repo.git.native :checkout, { "b" => true }, "readme-update"

githug/levels/rebase_onto.rb

Lines 36 to 37 in 2544b01

	repo.commits("readme-update").each { |commit| return false if commit.message == "Wrong changes" }
	return false unless repo.commits("readme-update").length == 4

spec/githug_spec.rb has 2 instances:

githug/spec/githug_spec.rb

Lines 241 to 242 in 2544b01

	`git checkout readme-update`
	`git rebase --onto master wrong_branch readme-update`

While scrolling through spec/githug_spec.rb, I noticed another branch that also use dashes:
long-feature-branch

levels/merge_squash.rb has 3 instances:

githug/levels/merge_squash.rb

Line 2 in 2544b01

description "Merge all commits from the long-feature-branch as a single commit."

githug/levels/merge_squash.rb

Line 11 in 2544b01

repo.git.native :checkout, {"b" => true}, 'long-feature-branch'

githug/levels/merge_squash.rb

Line 37 in 2544b01

# Check if changes from all the commits from long-feature-branch are included.

spec/githug_spec.rb has 1 instance:

githug/spec/githug_spec.rb

Line 270 in 2544b01

`git merge --squash long-feature-branch`

And while writing this I noticed this name new-feature, but I'm not sure if it's a branch name or a git command name. It's listed 1 time here:

githug/spec/githug_spec.rb

Line 252 in 2544b01

commit = `git log new-feature --oneline -n 3 | tail -1 | cut -d " " -f 1`

And 4 times here:
https://github.com/Gazler/githug/blob/2544b01546d00165cd7f7059b965be85e1e15006/levels/cherry-pick/.githug/logs/HEAD

I didn't open a PR because I'm not sure if one/some/all dash names are there for a reason.

[Gazler]

Well spotted, thanks for opening this. As the levels were contributed from many contributors, it is likely that some had their own convention for branch names. I'd be happy for a PR that standardises this to use dashed-branch-names instead of underscored_branch_names.

[duianto]

To start with, the https://github.com/Gazler/githug#writing-levels section should mention that branch names should use dashes, so that any new levels that are created will use that style.

[duianto]

Should repository names and tags also use dashes?

my_cloned_repo

githug/levels/clone_to_folder.rb

Lines 2 to 5 in 6b4c41d

	description "Clone the repository at https://github.com/Gazler/cloneme to `my_cloned_repo`."
	solution do
	repo("my_cloned_repo").commit("157b2b61f29ab9df45f31c7cd9cb5d8ff06ecde4")

tag_to_be_pushed

githug/levels/push_tags.rb

Line 16 in 2544b01

repo.git.tag({'f' => true}, "tag_to_be_pushed")

[duianto]

The find_old_branch level has 4 branches:

blowup_sun_for_ransom
cure_common_cold
kill_the_batman
solve_world_hunger

they seem to be listed here:
https://github.com/Gazler/githug/tree/2544b01546d00165cd7f7059b965be85e1e15006/levels/find_old_branch/.githug/refs/heads

can they be renamed directly or is there some git commands somewhere else that creates them?

[duianto]

The conflict level calls the branch mybranch

githug/levels/conflict.rb

Line 2 in 6b4c41d

description "You need to merge mybranch into the current branch (master). But there may be some incorrect changes in mybranch which may cause conflicts. Solve any merge-conflicts you come across and finish the merge."

https://github.com/Gazler/githug/tree/2544b01546d00165cd7f7059b965be85e1e15006/levels/conflict/.githug/refs/heads

Should it be called my-branch to match the other branch names?

[Gazler]

Should repository names and tags also use dashes?

I think that makes sense.

can they be renamed directly or is there some git commands somewhere else that creates them?

They can be renamed directly, the files are a reference to a sha, so should be fine.

Should it be called my-branch to match the other branch names?

Sounds good to me!