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

(maint) Fix broken links to discussions/issues/PRs in README #2560

Merged
merged 1 commit into from
Oct 28, 2024

Conversation

sryze
Copy link
Contributor

@sryze sryze commented Oct 26, 2024

Description

Fixed a few links to repository pages inside the README such as Discussions, Issues, Pull Requests. Also fixed a typo.

GitHub treats relative links as relative to repo's code root directory, so discussions becomes blob/master/discussions instead of the intended page. One common workaround is to use a relative path that goes back 2 levels like ../../discussions.

Motivation and Context

How Has this Been Tested?

Screenshot (if appropriate, usually isn't needed):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Migrated package (a package has been migrated from another repository)

Checklist:

  • My code follows the code style of this repository.
  • My change requires a change to documentation (this usually means the notes in the description of a package).
  • I have updated the documentation accordingly (this usually means the notes in the description of a package).
  • I have updated the package description and it is less than 4000 characters.
  • All files are up to date with the latest Contributing Guidelines
  • The added/modified package passed install/uninstall in the Chocolatey Test Environment(https://github.com/chocolatey-community/chocolatey-test-environment/). Note that we don't support the use of any other environment.
  • The changes only affect a single package (not including meta package).

@AppVeyorBot
Copy link

✅ Package verification completed without issues. PR is now pending human review

README.md Outdated Show resolved Hide resolved
@AppVeyorBot
Copy link

✅ Package verification completed without issues. PR is now pending human review

@AdmiringWorm AdmiringWorm changed the title Fix broken links to discussions/issues/PRs in README (maint) Fix broken links to discussions/issues/PRs in README Oct 28, 2024
Copy link
Member

@AdmiringWorm AdmiringWorm left a comment

Choose a reason for hiding this comment

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

LGTM

@AdmiringWorm AdmiringWorm merged commit 6e42de3 into chocolatey-community:master Oct 28, 2024
1 check passed
@AdmiringWorm
Copy link
Member

@sryze thanks for getting those links updated 👍

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