Skip to content

Explain how to link an issue in pr create#2909

Merged
mislav merged 1 commit intotrunkfrom
docs-pr-create
Feb 5, 2021
Merged

Explain how to link an issue in pr create#2909
mislav merged 1 commit intotrunkfrom
docs-pr-create

Conversation

@mislav
Copy link
Contributor

@mislav mislav commented Feb 3, 2021

Fixes #2879

Copy link
Contributor

@samcoe samcoe left a comment

Choose a reason for hiding this comment

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

Do we want to mention the docs (https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue) for further information?

Also, should we include Resolves in the list of verbs that will automatically close an issue?

@mislav
Copy link
Contributor Author

mislav commented Feb 4, 2021

@samcoe All good questions! I'm not sure if I want to list all the possible keywords, since the sentence might become large. I thought that just listing "Fixes" and "Closes" would be enough. It's a good idea to link to the docs as you suggested, but I wonder whether the link is a bit long to include in our help output? It's 97 characters long, and we try to keep the docs ~80 characters wide.

/cc @ampinsk for thoughts

@ampinsk
Copy link

ampinsk commented Feb 4, 2021

Yeah, I wish adding links was easier but I think it's best to keep this helpful but concise. I think it's good as is 👍

@mislav mislav merged commit 092cc4c into trunk Feb 5, 2021
@mislav mislav deleted the docs-pr-create branch February 5, 2021 09:02
Copy link

@MONIMAKER365 MONIMAKER365 left a comment

Choose a reason for hiding this comment

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

pkg/cmd/pr/create/create.go

@MONIMAKER365

This comment has been minimized.

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.

Ability to link issues to pull requests

5 participants