forked from jupyterlab/jupyterlab
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into lighthouse
- Loading branch information
Showing
951 changed files
with
158,542 additions
and
149,281 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
[bumpversion] | ||
current_version = 1, 0, 2, 'final', 0 | ||
commit = False | ||
tag = False | ||
parse = (?P<major>\d+)\,\ (?P<minor>\d+)\,\ (?P<patch>\d+)\,\ \'(?P<release>\S+)\'\,\ (?P<build>\d+) | ||
serialize = | ||
{major}, {minor}, {patch}, '{release}', {build} | ||
[bumpversion:part:release] | ||
optional_value = final | ||
values = | ||
alpha | ||
candidate | ||
final | ||
[bumpversion:part:build] | ||
[bumpversion:file:jupyterlab/_version.py] | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,26 @@ | ||
Fixes # | ||
<!-- | ||
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/master/CONTRIBUTING.md | ||
--> | ||
|
||
**Screenshots** | ||
If applicable, add before and after screenshots to help show the issue being fixed, or the appearance of a new feature. | ||
## 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 here. --> | ||
|
||
## Backwards-incompatible changes | ||
|
||
<!-- Describe any backwards-incompatible changes to JupyterLab public APIs. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,4 +19,5 @@ examples/app/schemas | |
tests/**/coverage | ||
docs/_build | ||
docs/api | ||
**/package.json | ||
**/package.json | ||
.eggs |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,20 +4,22 @@ 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. | ||
We encourage those that are new to the code base to implement and/or ask | ||
questions about these issues. | ||
|
||
## Tag Issues with Labels | ||
If you believe you’ve found a security vulnerability in JupyterLab or any | ||
Jupyter project, please report it to | ||
[[email protected]](mailto:[email protected]). If you prefer to encrypt your | ||
security reports, you can use [this PGP public | ||
key](https://jupyter-notebook.readthedocs.io/en/stable/_downloads/ipython_security.asc). | ||
|
||
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). | ||
|
@@ -39,8 +41,24 @@ 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/) | ||
|
||
### Installing Node.js and jlpm | ||
|
||
Building JupyterLab from its GitHub source code requires Node.js. | ||
|
@@ -69,7 +87,7 @@ If you use `conda`, you can install notebook using: | |
conda install -c conda-forge notebook | ||
``` | ||
|
||
You may also want to install `nb_conda_kernels` to have a kernel option for different [conda environments](http://conda.pydata.org/docs/using/envs.html) | ||
You may also want to install `nb_conda_kernels` to have a kernel option for different [conda environments](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html) | ||
|
||
```bash | ||
conda install -c conda-forge nb_conda_kernels | ||
|
@@ -136,9 +154,11 @@ jupyter lab --dev-mode | |
``` | ||
|
||
Development mode ensures that you are running the JavaScript assets that are | ||
built in the dev-installed Python package. When running in dev mode, a red | ||
stripe will appear at the top of the page; this is to indicate running | ||
an unreleased version. | ||
built in the dev-installed Python package. Note that when running in dev mode, | ||
extensions will not be activated by default. | ||
|
||
When running in dev mode, a red stripe will appear at the top of the page; | ||
this is to indicate running an unreleased version. | ||
|
||
### Build and Run the Tests | ||
|
||
|
@@ -192,8 +212,8 @@ jlpm create:test <package-directory-name> | |
#### Running Jest Tests | ||
|
||
For those test folders that use `jest`, they can be run as `jlpm test` to run the files | ||
directly. You can also use `jlpm test --namePattern=<regex>` to specify specific test | ||
suite names, and `jlpm test --pathPattern=<regex>` to specify specific test module names. In order to watch the code, add a `debugger` line in your code and run `jlpm watch`. This will start a node V8 debugger, which can be debugged | ||
directly. You can also use `jlpm test --testNamePattern=<regex>` to specify specific test | ||
suite names, and `jlpm test --testPathPattern=<regex>` to specify specific test module names. In order to watch the code, add a `debugger` line in your code and run `jlpm watch`. This will start a node V8 debugger, which can be debugged | ||
in Chrome by browsing to `chrome://inspect/` and launching the remote session. | ||
|
||
## Performance Testing | ||
|
@@ -520,7 +540,10 @@ a package by importing from it in the TypeScript file, and then running: | |
`jlpm run integrity` from the repo root. | ||
|
||
We also have scripts for creating and removing packages in `packages/`, | ||
`jlpm run create:package` and `jlpm run remove:package`. | ||
`jlpm run create:package` and `jlpm run remove:package`. When creating a package, | ||
if it is meant to be included in the core bundle, add the `jupyterlab: { coreDependency: true }` | ||
metadata to the `package.json`. Packages with `extension` or `mimeExtension` metadata | ||
are considered to be a core dependency unless they are explicitly marked otherwise. | ||
|
||
## Testing Changes to External Packages | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.