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: standardize how issues are referenced #317

Merged
merged 1 commit into from May 4, 2022
Merged

docs: standardize how issues are referenced #317

merged 1 commit into from May 4, 2022

Conversation

agilgur5
Copy link
Collaborator

@agilgur5 agilgur5 commented May 3, 2022 •
edited

Summary

Consistently use the same style when referencing issues in this repo and in other repos -- follow how GitHub does it.

Details

  • fix: missing # in outDir reference ("83")

  • use org/repo#num consistently

    • this is how GitHub displays references to other repos in comments as well, so consistent with the rest of GH too
    • previously was either Microsoft/TypeScript/issues/num or rollup/issues/num inconsistently
    • links haven't changed, just the text of the them

Unrelated:

  • auto-trim some whitespace-only lines
    • my editor does this automatically, and most of the README has trimmed whitespace anyway, so this keeps it consistent

Preview / Rendered Markdown

See this PR's rendered README.md

@agilgur5
docs: standardize how issues are referenced
8346a42 
- fix: missing `#` in `outDir` reference ("83")

- use `org/repo#num` consistently
  - previously was `Microsoft/TypeScript/issues/num` or
    `rollup/issues/num` inconsistently
  - this is how GitHub displays references to other repos in comments as
    well, so consistent with the rest of GH too
  - links haven't changed, just the text of the them

- auto-trim some whitespace-only lines
  - my editor does this automatically, and most of the README has
    trimmed whitespace anyway, so this keeps it consistent
@agilgur5 agilgur5 added the scope: docs Documentation could be improved. Or changes that only affect docs label May 3, 2022
@ezolenko ezolenko merged commit 00bf86f into ezolenko:master May 4, 2022
@agilgur5 agilgur5 added the kind: dx Improvements to dev experience, e.g. error messages, logging, external-facing docs, etc label Jul 22, 2022
@agilgur5 agilgur5 deleted the docs-standardize-issue-references branch July 2, 2023 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
kind: dx Improvements to dev experience, e.g. error messages, logging, external-facing docs, etc scope: docs Documentation could be improved. Or changes that only affect docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@agilgur5 @ezolenko