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

git-changelog: add page #7359

Merged
merged 4 commits into from
Nov 6, 2021
Merged

Conversation

deadpyxel
Copy link
Contributor

  • The page (if new), does not already exist in the repository.
  • The page is in the correct platform directory (common/, linux/, etc.)
  • The page has 8 or fewer examples.
  • The PR title conforms to the recommended templates.
  • The page follows the content guidelines.
  • The page description includes a link to documentation or a homepage (if applicable).

Version of the command being documented (if known): 6.2.0

Opened from #5137

@tldr-bot

This comment has been minimized.

@navarroaxel navarroaxel added hacktoberfest-accepted PRs that were opened for Hacktoberfest, but may not actually get merged until November. new command Issues requesting creation of a new page. labels Nov 1, 2021
> Part of `git-extras`.
> More information: <https://github.com/tj/git-extras/blob/master/Commands.md#git-changelog>.

- Update existing file or creating a new History.md file with pretty formatted output:
Copy link
Member

Choose a reason for hiding this comment

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

What is a non pretty output?

Suggested change
- Update existing file or creating a new History.md file with pretty formatted output:
- Update existing file or create a new `History.md` file with the commit messages since the latest Git tag:

Copy link
Contributor Author

@deadpyxel deadpyxel Nov 1, 2021

Choose a reason for hiding this comment

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

I found this term ("pretty") in the man page. There there're some additional info about what kind of formatting you can do:

You could customize the changelog format via some git config options.

- git config changelog.format $format controls the format of each commit. It will be passed  as  git  log  --pretty=format:$format. The default value is `* %s`.
- git config changelog.mergeformat $format is like changelog.format but only used when --merges-only is specified. The default value is * %s%n%w(64,4,4)%b.

Do you believe that some examples of this would be useful? Or the removal of "pretty" would be best?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mfrw can you take a look at this and give me your thoughts as well?

pages/common/git-changelog.md Outdated Show resolved Hide resolved
pages/common/git-changelog.md Outdated Show resolved Hide resolved
pages/common/git-changelog.md Outdated Show resolved Hide resolved
pages/common/git-changelog.md Outdated Show resolved Hide resolved
Co-authored-by: Axel Navarro <navarroaxel@gmail.com>
Copy link
Member

@mfrw mfrw left a comment

Choose a reason for hiding this comment

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

A few nitpicks :)

pages/common/git-changelog.md Outdated Show resolved Hide resolved
pages/common/git-changelog.md Outdated Show resolved Hide resolved
pages/common/git-changelog.md Outdated Show resolved Hide resolved
pages/common/git-changelog.md Outdated Show resolved Hide resolved
Co-authored-by: Muhammad Falak R Wani <falakreyaz@gmail.com>
@deadpyxel deadpyxel requested a review from mfrw November 4, 2021 15:23
Copy link
Member

@mfrw mfrw left a comment

Choose a reason for hiding this comment

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

LGTM.
Thank you for your contribution @deadpyxel

@navarroaxel navarroaxel merged commit a453e26 into tldr-pages:main Nov 6, 2021
@deadpyxel deadpyxel deleted the git-changelog branch November 10, 2021 02:19
@bl-ue bl-ue mentioned this pull request Aug 7, 2022
73 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted PRs that were opened for Hacktoberfest, but may not actually get merged until November. new command Issues requesting creation of a new page.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants