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

Correct link to automatetheboringstuff.com in README #3

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Correct link to automatetheboringstuff.com in README #3

wants to merge 1 commit into from

Conversation

conorhennessy
Copy link

@conorhennessy conorhennessy commented Mar 29, 2019

The second link to the REAMDE linking to your book was dead.

It linked to https://automatetheboringstuffwithpython.com/, which is a dead link.
I have corrected it to https://automatetheboringstuff.com/ as this is the correct link, I belive?

This PR resolves #2

The second link on this page for your book was dead. So I have fixed it
@codespearhead
Copy link

Can you link this PR to that issue ( #2 ), like this?

@conorhennessy
Copy link
Author

conorhennessy commented Mar 29, 2024

Can you link this PR to that issue ( #2 ), like this?

@codespearhead, I'm not sure what you are asking...

I have already linked the reported issue in this PR's description by mentioning the issue number. Is that okay?

I do see you have mentioned the quoted question (linking springdoc/springdoc-openapi#2540) across a number of PRs in other repositories. How come?

@conorhennessy conorhennessy changed the title Tiny little link fix Correct link to automatetheboringstuff.com in README Mar 29, 2024
@codespearhead
Copy link

codespearhead commented Mar 29, 2024

@conorhennessy

Change this:

This PR resolves issue #2

To this:

Resolves #2

That will link this PR to the issue it intends to fix, making that issue show up in the lower right-hand corner of the page in desktop mode.

GridArt_20240329_120957750

Having an issue with a linked PR will allow us to keep track of which issues already have a solution ready to be merged, or at least check which ones have someone working on the solution already to reduce reworks and optimize the maintainer's time by having them favor the ones that have people actively working on them.

Besides, when a repository has a great number of PRs or open issues, that usually means the same issue has been reported multiple times or have already been fixed, but they're still open because they weren't closed by the original author: when issues are linked to a PR, they're automatically closed once the PR is merged.

Mentioning the issue id will only automatically link a PR to it if it's preceded by a specific set of keywords, and "fixing" is not one of them. As per the documentation:

You can link a pull request to an issue by using a supported keyword in the pull request's description or in a commit message. The pull request must be on the default branch.

  • close
  • closes
  • closed
  • fix
  • fixes
  • fixed
  • resolve
  • resolves
  • resolved

@conorhennessy
Copy link
Author

conorhennessy commented Mar 29, 2024

@codespearhead

Ahh right, the keyword there! Thank you very much for clarifying, that's pure handy!

I've corrected how it is referenced to in the PR description and all is now linked.

I'll make sure to make use of this in the future too! 🚀

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.

Dead link :(
2 participants