From b563c05e33ccf48749d9f39dba273209d8926bb5 Mon Sep 17 00:00:00 2001 From: Jason Grout Date: Thu, 25 Apr 2019 08:01:25 -0700 Subject: [PATCH 1/8] Simplify PR template. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * I put the note to the author in an HTML comment so it doesn’t appear in the PR description. * I simplified the language to be more direct about what the user should do. * I took out “We strongly encourage the community to open an issue … before a PR” since at this point, their PR is open and work is done already. If this is our stance, we should tell people before this stage. * I took out “Provide a list of packages” since that should just be automated from the files that are touched. * I reworded a few points to be more direct and shorter and use simpler language. --- .github/pull_request_template.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 742a1c1ee32c..9cc431ca8654 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,10 +1,11 @@ + - [ ] Look through open pull requests to see if someone has already started working on this. -- [ ] Note what issue(s) this pull request addresses. (We strongly encourage the community to open an issue describing proposed work before opening a pull request.) -- [ ] Provide a detailed description of the pull request. (Why are these changes necessary? How have they been implemented?) -- [ ] For UI/UX changes, include before/after screenshots -- [ ] Include a narrative description of visual or user interaction changes. How does your design effectively address the problem? -- [ ] Provide a list of Jupyterlab packages the pull request modifies. -- [ ] Describe any backwards incompatible changes to Jupyterlab’s public APIs. +- [ ] Note what issue(s) this pull request addresses. +- [ ] Describe the changes and reasons for them in this pull request. +- [ ] Describe visual or user interaction changes in sentences. How does your design effectively address the problem? +- [ ] For user interface changes, include before/after screenshots +- [ ] Describe any backwards-incompatible changes to JupyterLab public APIs. From 551596f502b3d8355619a1978e255ad99ef64692 Mon Sep 17 00:00:00 2001 From: Jason Grout Date: Thu, 25 Apr 2019 08:20:48 -0700 Subject: [PATCH 2/8] Simplify PR template language even more. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Make language consistent across items and reorder items so similar items are next to each other. * Eliminate the possibly accusatory “you” language --- .github/pull_request_template.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 9cc431ca8654..488030760e93 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,11 +1,11 @@ - -- [ ] Look through open pull requests to see if someone has already started working on this. -- [ ] Note what issue(s) this pull request addresses. -- [ ] Describe the changes and reasons for them in this pull request. -- [ ] Describe visual or user interaction changes in sentences. How does your design effectively address the problem? +- [ ] Note the issue numbers this pull request addresses. +- [ ] Note any other pull requests that address this issue and how this pull request is different. +- [ ] Describe in sentences the code changes and how they address the issue. +- [ ] Describe in sentences the visual or user interaction changes and how they address the issue. +- [ ] Describe in sentences any backwards-incompatible changes to JupyterLab public APIs. - [ ] For user interface changes, include before/after screenshots -- [ ] Describe any backwards-incompatible changes to JupyterLab public APIs. From af5bc97cfe508785882dc24f70c1f9d5076ac0e1 Mon Sep 17 00:00:00 2001 From: Jason Grout Date: Thu, 25 Apr 2019 08:33:23 -0700 Subject: [PATCH 3/8] Move checklist items to formatted templated sections. --- .github/pull_request_template.md | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 488030760e93..53063053eceb 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -3,9 +3,23 @@ Hi! Thanks for contributing to JupyterLab. Please look through the checklist below before submitting your pull request. --> -- [ ] Note the issue numbers this pull request addresses. -- [ ] Note any other pull requests that address this issue and how this pull request is different. -- [ ] Describe in sentences the code changes and how they address the issue. -- [ ] Describe in sentences the visual or user interaction changes and how they address the issue. -- [ ] Describe in sentences any backwards-incompatible changes to JupyterLab public APIs. -- [ ] For user interface changes, include before/after screenshots +## References + + + + + + +## Code changes + + + +## User-facing changes + + + + + + +## Backwards incompatibe changes + From b2e5fefcc7a1d8fc4462d9b210ee9f69978037ea Mon Sep 17 00:00:00 2001 From: Jason Grout Date: Thu, 25 Apr 2019 08:39:51 -0700 Subject: [PATCH 4/8] Update initial greeting and instructions for PR template. --- .github/pull_request_template.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 53063053eceb..fa0a6c33d5fb 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,25 +1,21 @@ - + ## References - + - ## Code changes - + ## User-facing changes - + - ## Backwards incompatibe changes + From f5e475d69fdca1367b2af54b35a5f3b8601908ee Mon Sep 17 00:00:00 2001 From: Jason Grout Date: Thu, 25 Apr 2019 08:54:56 -0700 Subject: [PATCH 5/8] Fix typo --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index fa0a6c33d5fb..474cfb033434 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -16,6 +16,6 @@ -## Backwards incompatibe changes +## Backwards-incompatible changes From 1beddfa036b4ee230dfaef19bdfbc9da1edf4f5f Mon Sep 17 00:00:00 2001 From: Jason Grout Date: Thu, 25 Apr 2019 08:56:47 -0700 Subject: [PATCH 6/8] Make language asking for screenshots simpler and more consistent. --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 474cfb033434..ef9ee49d55df 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -14,7 +14,7 @@ - + ## Backwards-incompatible changes From 6fcd7f1d75aa5d5bab5d9b861f8c66f87c24edc1 Mon Sep 17 00:00:00 2001 From: Jason Grout Date: Fri, 26 Apr 2019 07:52:35 -0700 Subject: [PATCH 7/8] Document that generally an issue should be opened before a PR. --- .github/pull_request_template.md | 9 +++++++-- CONTRIBUTING.md | 27 +++++++++++++++++++-------- 2 files changed, 26 insertions(+), 10 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ef9ee49d55df..bbba50ca3e45 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,8 +1,13 @@ - + ## References - + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 229ec17beabc..5fd4be586947 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,9 +4,9 @@ If you're reading this section, you're probably interested in contributing to JupyterLab. Welcome and thanks for your interest in contributing! Please take a look at the Contributor documentation, familiarize yourself with -using JupyterLab, and introduce yourself on the mailing list and share -what area of the project you are interested in working on. Please see also the -Jupyter [Community Guides](https://jupyter.readthedocs.io/en/latest/community/content-community.html). +using JupyterLab, and introduce yourself to the community (on the mailing list +or discourse) and share what area of the project you are interested in working +on. Please also see the Jupyter [Community Guides](https://jupyter.readthedocs.io/en/latest/community/content-community.html). We have labeled some issues as [good first issue](https://github.com/jupyterlab/jupyterlab/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) or [help wanted](https://github.com/jupyterlab/jupyterlab/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) that we believe are good examples of small, self-contained changes. @@ -19,11 +19,7 @@ Jupyter project, please report it to security reports, you can use [this PGP public key](https://jupyter-notebook.readthedocs.io/en/stable/_downloads/ipython_security.asc). -## Tag Issues with Labels - -Users without the commit rights to the jupyterlab repository can also tag the issues with labels. For example: To apply the label `foo` and `bar baz` to an issue, comment `@meeseeksdev tag foo "bar baz"` on the issue. - -## General Guidelines +## General Guidelines for Contributing For general documentation about contributing to Jupyter projects, see the [Project Jupyter Contributor Documentation](https://jupyter.readthedocs.io/en/latest/contributor/content-contributor.html) and [Code of Conduct](https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md). @@ -45,6 +41,21 @@ installing a prettier extension for your code editor and configuring it to format your code with a keyboard shortcut or automatically on save. +## Submitting a Pull Request Contribution + +Generally, an issue should be opened describing a piece of proposed work and the +issues it solves before a pull request is opened. This lets community members +participate in the design discussion, makes others aware of work being done, and +sets the stage for a fruitful community interaction. A pull request should +reference the issue it is addressing. + +### Tag Issues with Labels + +Users without the commit rights to the JupyterLab repository can tag issues with +labels using the `@meeseeksdev` bot. For example: To apply the label `foo` and +`bar baz` to an issue, comment `@meeseeksdev tag foo "bar baz"` on the issue. + + ## Setting Up a Development Environment You can launch a binder with the latest JupyterLab master to test something (this may take a few minutes to load): [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab/jupyterlab/master?urlpath=lab-dev/) From 4d9719096ea8f04fdb8f21e08f8f1db8028a4cfd Mon Sep 17 00:00:00 2001 From: Jason Grout Date: Fri, 26 Apr 2019 07:57:13 -0700 Subject: [PATCH 8/8] =?UTF-8?q?Remove=20=E2=80=9Chere=E2=80=9D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/pull_request_template.md | 10 +++++----- CONTRIBUTING.md | 1 - 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index bbba50ca3e45..b289e910ccd2 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -7,20 +7,20 @@ https://github.com/jupyterlab/jupyterlab/blob/master/CONTRIBUTING.md ## References - + - + ## Code changes - + ## User-facing changes - + ## Backwards-incompatible changes - + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5fd4be586947..6017c4d2406f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,7 +55,6 @@ Users without the commit rights to the JupyterLab repository can tag issues with labels using the `@meeseeksdev` bot. For example: To apply the label `foo` and `bar baz` to an issue, comment `@meeseeksdev tag foo "bar baz"` on the issue. - ## Setting Up a Development Environment You can launch a binder with the latest JupyterLab master to test something (this may take a few minutes to load): [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab/jupyterlab/master?urlpath=lab-dev/)