Skip to content

Conversation

TheLastGimbus
Copy link
Contributor

  • The page (if new), does not already exist in the repo.
  • 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).

Add a new page for gh issue

Ref: #4701

@tldr-bot
Copy link

The build for this PR failed with the following error(s):

pages/common/gh-issue.md:7: TLDR007 Example descriptions should be surrounded by empty lines
pages/common/gh-issue.md:20: TLDR008 File should contain no trailing whitespace

Please fix the error(s) and push again.

@tldr-bot
Copy link

The build for this PR failed with the following error(s):

pages/common/gh-issue.md:7: TLDR007 Example descriptions should be surrounded by empty lines

Please fix the error(s) and push again.

@tldr-bot
Copy link

The build for this PR failed with the following error(s):

pages/common/gh-issue.md:20 MD003/heading-style/header-style Heading style [Expected: atx; Actual: setext]
pages/common/gh-issue.md:20 MD025/single-title/single-h1 Multiple top level headings in the same document [Context: "`gh issue list -s closed -A {{..."]
Error: Parse error on line 22:
...<< Updated upstream=======- Check sta
----------------------^
Expecting 'NEWLINE', 'BACKTICK', got 'TEXT'

Please fix the error(s) and push again.

@navarroaxel navarroaxel added the new command Issues requesting creation of a new page or PRs adding a new page for a command. label Oct 24, 2020
Copy link
Collaborator

@navarroaxel navarroaxel left a comment

Choose a reason for hiding this comment

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

Thanks @TheLastGimbus, I left some comments.

@TheLastGimbus
Copy link
Contributor Author

TheLastGimbus commented Oct 25, 2020

I commited some of changes, but for the rest (and also applying for my 2 other gh command PRs), I have a question:

I'm new here, and I'm obiously not a maintainer, but from what I see (or would want) TL;DR pages to be - a quick, beginner friendly/human-readable examples for how to do common tasks

That's why I

  • used more human'ish terms - like "made" instead of "authored"
  • used real-life examples, instead of technical "this is option X, input Y in it"
  • focused on what the user wanted (in examples) in the first place, not what the command does.

That's my point of view - but if this repo has strict design ways and you want me to change them to be more technical - it's all right 👍

@navarroaxel
Copy link
Collaborator

@TheLastGimbus Don't worry, just apply a few style changes that I suggested and we can check if the page is correct or need more work.

Copy link
Member

@sbrl sbrl left a comment

Choose a reason for hiding this comment

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

Thanks for the new page! I've left a comment below for you to review.

Copy link
Member

@owenvoke owenvoke left a comment

Choose a reason for hiding this comment

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

LGTM after the requested change has been resolved. 👍🏻

@sbrl sbrl added the hacktoberfest-accepted PRs that were opened for Hacktoberfest, but may not actually get merged until November. label Oct 28, 2020
@TheLastGimbus TheLastGimbus deleted the gh-issue branch October 28, 2020 21:53
@TheLastGimbus TheLastGimbus restored the gh-issue branch October 28, 2020 21:55
@TheLastGimbus TheLastGimbus reopened this Oct 28, 2020
@owenvoke
Copy link
Member

@sbrl, is this ok to merge? Looks like your change has been applied. 👍🏻

Copy link
Member

@sbrl sbrl left a comment

Choose a reason for hiding this comment

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

Oh, thanks for reminding me @owenvoke!

Looks ok to me :D

@sbrl sbrl merged commit f51e81f into tldr-pages:master Nov 1, 2020
@TheLastGimbus TheLastGimbus deleted the gh-issue branch November 3, 2020 10:52
@navarroaxel navarroaxel mentioned this pull request Jan 10, 2021
14 tasks
@dmmqz dmmqz mentioned this pull request Sep 18, 2025
35 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 or PRs adding a new page for a command.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants