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.

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

Jump to bottom

docs: add link to git.md #50

Merged
merged 2 commits into from
Sep 21, 2024
Merged

docs: add link to git.md #50

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c81817
docs: add link to git.md
liya-oz Sep 9, 2024
0fe51c9
docs: add link to git.md
liya-oz Sep 9, 2024
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
3 changes: 3 additions & 0 deletions git-and-github/git.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,9 @@ The above simple commands will be about 95% of what you will do with git. As lon

This should give you a better idea of what it is exactly that you want to fix and should help you describe what you want to do. If you can describe your problem well then the internet (or ChatGPT) will always have an answer.

You can also find concise guidelines on writing clear, human- and machine-readable commits on the [Conventional Commits site](https://www.conventionalcommits.org/en/v1.0.0/).
Copy link

Choose a reason for hiding this comment

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

What is the purpose of dash after the "human" keyword? I might not be seeing it properly as reviewing from my mobile phone.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you @allhandsondeck. Yes, you are right. I meant "human-readable and machine-readable commits", but that might not have been clear enough. Let me write it in the different way.

"You can also find concise guidelines on writing clear, human-readable and machine-readable commit messages on the Conventional Commits site."

or

"You can also find concise guidelines on writing clear, well-structured commit messages on the Conventional Commits site."

Which one do you find better?

Copy link
Member

Choose a reason for hiding this comment

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

I like

"You can also find concise guidelines on writing clear, well-structured commit messages on the Conventional Commits site."

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@stasel I have added an additional commit with updates. Please review the changes.



# Extra reading

If you just can't get enough, here are some extra links that mentors/students have found useful concerning this topic:
Expand Down