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

docs: add link to git.md #50

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

liya-oz
Copy link

@liya-oz liya-oz commented Sep 9, 2024

New link with concise guidelines on writing clear, human- and machine-readable commitsConventional Commits site.

@@ -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/).

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
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
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.

Added a new link related to the Conventional Commits site.
@liya-oz liya-oz requested a review from stasel September 9, 2024 11:52
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