Skip to content

Conversation

@KH-Coder865
Copy link
Contributor

@KH-Coder865 KH-Coder865 commented Dec 18, 2025

What this PR does

Adds a pull request template to guide contributors toward structured and complete PR descriptions.
The template includes sections for references, code changes, user-facing changes, backwards-incompatible changes, testing, and checklist.

Why this is useful

  • Improves clarity and consistency for contributor PRs
  • Reduces incomplete or unstructured PR submissions
  • Aligns with existing JupyterLab and Jupyter Scheduler templates
  • Documentation-only change with no code impact

Related issues / references

Closes Issue

Closes: #7717

Checklist

  • Code follows the project's code style
  • Documentation updated (In /.github added PR template)

Labels

  • enhancement

@github-actions
Copy link
Contributor

Binder 👈 Launch a Binder on branch KH-Coder865/notebook/add-pr-template

@KH-Coder865
Copy link
Contributor Author

This PR only adds a pull request template (documentation / workflow change).
No runtime or testable code is modified.
The coverage failure appears unrelated to the change itself.
I don’t have permission to add labels; once an appropriate label is added, the enforce-label check should pass.
Happy to adjust anything if needed.

@KH-Coder865
Copy link
Contributor Author

KH-Coder865 commented Dec 19, 2025

Requesting maintainers to add the enhancement label.

@KH-Coder865 KH-Coder865 marked this pull request as draft December 19, 2025 10:06
@KH-Coder865 KH-Coder865 marked this pull request as ready for review December 19, 2025 10:06
@KH-Coder865
Copy link
Contributor Author

Requesting a review for this PR from the maintainers.

Copy link
Contributor

@andrii-i andrii-i left a comment

Choose a reason for hiding this comment

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

Hi @KH-Coder865. Thank you for contributing this PR.

A couple of comments:

  1. Note that currently PR adds both .github/PULL_REQUEST_TEMPLATE/pull_request_template.md and .github/pull_request_template.md. We probably don't need both unless there's a good reason. I'd prefer to leave only .github/pull_request_template.md for consistency with Jupyterlab and other Jupyter projects unless there is a good reason to do it differently.
  2. For the sake of consistency and reusing good practices like instructions in hidden text, could we please use this template as a base https://github.com/jupyterlab/jupyterlab/blob/main/.github/pull_request_template.md?
<!--
Thanks for contributing to JupyterLab!
Please fill out the following items to submit a pull request.
See the contributing guidelines for more information:
https://github.com/jupyterlab/jupyterlab/blob/main/CONTRIBUTING.md
-->

## References

<!-- Note issue numbers this pull request addresses (should be at least one, see contributing guidelines above). -->

<!-- Note any other pull requests that address this issue and how this pull request is different. -->

## Code changes

<!-- Describe the code changes and how they address the issue. -->

## User-facing changes

<!-- Describe any visual or user interaction changes and how they address the issue. -->

<!-- For visual changes, include before and after screenshots or GIF/mp4/other video demo here. -->

## Backwards-incompatible changes

<!-- Describe any backwards-incompatible changes to JupyterLab public APIs. -->

Thank you.

@andrii-i andrii-i mentioned this pull request Jan 4, 2026
@KH-Coder865
Copy link
Contributor Author

Yes @andrii-i .
Thank you for reviewing my PR.

Most probably, both the PR templates had been committed as a mistake.

Surely, I will use the given template as our base template for pull requests.

Kindly let me know if any further changes are needed.

Thank you.

2 similar comments
@KH-Coder865
Copy link
Contributor Author

Yes @andrii-i .
Thank you for reviewing my PR.

Most probably, both the PR templates had been committed as a mistake.

Surely, I will use the given template as our base template for pull requests.

Kindly let me know if any further changes are needed.

Thank you.

@KH-Coder865
Copy link
Contributor Author

Yes @andrii-i .
Thank you for reviewing my PR.

Most probably, both the PR templates had been committed as a mistake.

Surely, I will use the given template as our base template for pull requests.

Kindly let me know if any further changes are needed.

Thank you.

@KH-Coder865 KH-Coder865 requested a review from andrii-i January 6, 2026 08:25
@KH-Coder865
Copy link
Contributor Author

Hi @andrii-i .
I have successfully edited the template by replacing it with standard template, and removed the duplicate templates keeping only the one you said.

Kindly confirm this.
Thank you.

@KH-Coder865 KH-Coder865 marked this pull request as draft January 6, 2026 10:40
@KH-Coder865 KH-Coder865 marked this pull request as ready for review January 6, 2026 10:52
@KH-Coder865
Copy link
Contributor Author

I can't make out why the test lint is still failing.
Please tell if anything can be done from my side
Thank you

@andrii-i
Copy link
Contributor

andrii-i commented Jan 7, 2026

Hi @KH-Coder865. This seems to be a CI / dependency error unrelated to the content of this PR.

Copy link
Contributor

@andrii-i andrii-i left a comment

Choose a reason for hiding this comment

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

Thank you @KH-Coder865. PR template looks good to me and is consistent with one used in JupyterLab (https://github.com/jupyterlab/jupyterlab/blob/main/.github/pull_request_template.md).

CI error is a CI / dependency error unrelated to the content of this PR.

@andrii-i
Copy link
Contributor

andrii-i commented Jan 7, 2026

CI is green after relaunching the workflow as advised by @krassowski, see jupyterlab/jupyterlab#18311.

@andrii-i andrii-i changed the title Add PR template for structured contributor PRs Add PR template Jan 7, 2026
@andrii-i andrii-i merged commit b8be130 into jupyter:main Jan 7, 2026
52 of 54 checks passed
@KH-Coder865
Copy link
Contributor Author

Thank you very much @andrii-i for clarification and guidance. Thanks to @krassowski.

@KH-Coder865 KH-Coder865 deleted the add-pr-template branch January 7, 2026 18:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add PR template

2 participants