Skip to content
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.

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

Added more explanatory text to basic-commits/README #196

Conversation

brent-clark-SED-Sw-Mgr
Copy link
Contributor

When working through the katas, I thought the explanatory text in the README could be improved a bit in many cases. This PR is almost too trivial to bother with, but wanted to start with something simple.


You can look at the bottom of this file, if you have not yet done basic git configuration.

## Setup:

1. Run `. setup.sh` (or `.\setup.ps1` in PowerShell)
1. Run `. setup.sh` (or `.\setup.ps1` in PowerShell) and `cd exercise`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The whole point of sourcing the script (i.e. running the script with dot space scriptname, or source scriptname) is that the script is run in the current shel process, and thus leaves you inside the exercise folder when done. So if you run the shel script the right way, it makes no sense and is not possible to cd exercise afterwards.'

The rest of the change looks good to me.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In powershell it might be different - I have no idea.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the cd.
(I thought the . setup.sh was a typo and you meant .\setup.sh. Hence my confusion)

This is a separate comment, but the readmes were recently changed to use numbered lists with increasing numbers.

1. Use git status to see which branch you are on.
2. What does git log look like?

Instead of

1. Use git status to see which branch you are on.
1. What does git log look like?

I plan to submit changes where I add items to the task and its going to look like I made a lot of changes when I only added a line or two.

@RandomSort
Copy link
Contributor

Thank you for your contribution - and sorry for leaving you hanging on this.

I am unsure of the general validity of advicing people to skip exercises - but I think this is very basic indeed so could be good to skip. Then in a classroom setting teacher can decide whether everyone should be "forced" to go through the fundamentals to build common language and things like that.

@RandomSort RandomSort merged commit dfcb536 into eficode-academy:master Oct 9, 2019
@brent-clark-SED-Sw-Mgr brent-clark-SED-Sw-Mgr deleted the add-to-basic-commits-readme branch October 12, 2019 19:47
CristianStanciu pushed a commit to CristianStanciu/git-katas that referenced this pull request Jun 2, 2022
…d-to-basic-commits-readme

Added more explanatory text to basic-commits/README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants