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

README: improve overall quality #494

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

trueNAHO
Copy link

@trueNAHO trueNAHO commented Jul 26, 2023

  • README: add empty lines for consistent paragraph formatting
  • README: capitalize bullet points consistently
  • README: punctuate bullet points consistently
  • README: format code blocks with bash instead of shell
    • The GitHub previewer has better color support for bash code blocks than for shell code blocks`.
  • README: remove initial code block indentation
  • README: code format commands and command names

@newren
Copy link
Owner

newren commented Jul 7, 2024

The commits generally look good. I like the split into separate commits, and you describe each change well.

While changing "filter-branch" to "filter-branch" is generally good and correct, changing "git filter-branch" to "git filter-branch" is not correct; the backtick should start before "git" in that case. I caught at least one example of that problem.

However, there's one big problem here -- I need to you to use your real name and real email in the author & committer, and include a Signed-off-by line (https://github.com/git/git/blob/master/Documentation/SubmittingPatches#L351). Can you do that? If so (and if you fix the backtick issue I mentioned above), I'd be happy to merge the changes.

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.

2 participants