-
Notifications
You must be signed in to change notification settings - Fork 5.6k
Add PR template #7792
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
Add PR template #7792
Conversation
|
This PR only adds a pull request template (documentation / workflow change). |
|
Requesting maintainers to add the |
|
Requesting a review for this PR from the maintainers. |
There was a problem hiding this 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:
- Note that currently PR adds both
.github/PULL_REQUEST_TEMPLATE/pull_request_template.mdand.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.mdfor consistency with Jupyterlab and other Jupyter projects unless there is a good reason to do it differently. - 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.
|
Yes @andrii-i . 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
|
Yes @andrii-i . 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. |
|
Yes @andrii-i . 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. |
|
Hi @andrii-i . Kindly confirm this. |
644b467 to
fc6a7b1
Compare
This reverts commit aaa9b19.
|
I can't make out why the test lint is still failing. |
|
Hi @KH-Coder865. This seems to be a CI / dependency error unrelated to the content of this PR. |
andrii-i
left a comment
There was a problem hiding this 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.
|
CI is green after relaunching the workflow as advised by @krassowski, see jupyterlab/jupyterlab#18311. |
|
Thank you very much @andrii-i for clarification and guidance. Thanks to @krassowski. |
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
Related issues / references
Closes Issue
Closes: #7717
Checklist
Labels
enhancement