Skip to content

PR template referencing things not present #17811

Closed
@janbrasna

Description

@janbrasna

Code of Conduct

What article on docs.github.com is affected?

https://raw.githubusercontent.com/github/docs/main/.github/PULL_REQUEST_TEMPLATE.md

What changes are you suggesting?

The PR template instructs me to some things that don't sound right, it may be just outdated terminology. Before addressing any of that in an actual PR I'm raising these for discussion:

  1. "changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes"

    • I don't see anything "Modified" in the comment; there's a separate deployment timeline event, and the comment contains only "Preview", "Production" and empty "What's changed". Nothing more there to click. 🤷‍♂️
      Was this meant to be something that's not there all the time, or has been removed/replaced?
  2. The PR intro mentions linking a PR, that sounds like a place for referencing an issue to me, so maybe:

-By explaining why you're making a change (or linking to a pull request) and what changes you've made, …
+By explaining why you're making a change (or linking to an issue) and what changes you've made, …
  1. The "local" links to CONTRIBUTING.md and types-of-contributions.md don't work in the context of a /compare… URL where the preview for new PR is being displayed, i. e. these two need to be converted to absolute like the others in the template.

I'll happily fix it if that's ok to touch the template file…

Additional information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    contributing docsContent related to our contributing docshelp wantedAnyone is welcome to open a pull request to fix this issue

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions