You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>`**
13
+
or `help wanted <https://github.com/jupyterlab/jupyterlab/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22>`**
18
14
that we believe are good examples of small, self-contained changes. We
19
15
encourage those that are new to the code base to implement and/or ask
20
16
questions about these issues.
21
17
22
18
If you believe you’ve found a security vulnerability in JupyterLab or
23
19
any Jupyter project, please report it to security@ipython.org. If you
24
-
prefer to encrypt your security reports, you can use `this PGP public
prefer to encrypt your security reports, you can use `this PGP public key <https://raw.githubusercontent.com/jupyter/notebook/master/docs/source/ipython_security.asc>`\_\_.
26
21
27
22
.. contents:: Table of contents
28
-
:local:
29
-
:depth: 1
23
+
:local:
24
+
:depth: 1
30
25
31
-
General Guidelines for Contributing
32
-
-----------------------------------
26
+
## General Guidelines for Contributing
33
27
34
28
For general documentation about contributing to Jupyter projects, see
`TypeScript <https://www.typescriptlang.org/Handbook>`**. See the `Style Guide <https://github.com/jupyterlab/jupyterlab/wiki/TypeScript-Style-Guide>`**.
43
34
44
-
All source code is formatted using `prettier <https://prettier.io>`__.
35
+
All source code is formatted using `prettier <https://prettier.io>`\_\_.
45
36
The benefit of using a code formatter like prettier is that it removes the topic of
46
37
code style from the conversation when reviewing pull requests, thereby
47
38
speeding up the review process.
48
39
49
-
You may use the prettier npm script (e.g. ``npm run prettier`` or
50
-
``yarn prettier``) to format the entire code base.
40
+
You may use the prettier npm script (e.g. `npm run prettier` or
41
+
`yarn prettier`) to format the entire code base.
51
42
We recommend installing a prettier extension for your code editor and
52
43
configuring it to format your code with a keyboard shortcut or
53
44
automatically on save.
54
45
55
-
Submitting a Pull Request Contribution
56
-
--------------------------------------
46
+
## Submitting a Pull Request Contribution
57
47
58
48
Generally, an issue should be opened describing a piece of proposed work
59
49
and the issues it solves before a pull request is opened.
@@ -16,10 +16,10 @@ The UI Toolkit is a component library for building web interfaces in Jupyter eco
16
16
17
17
Features of the library include:
18
18
19
-
-**Implements the Jupyter design language:** All components follow the design language of Jupyter – enabling developers to create extensions that have a consistent look and feel with the rest of the ecosystem.
20
-
-**Automatic support for color themes:** All components are designed with theming in mind and will automatically display the current application theme.
21
-
-**Use any tech stack:** The library ships as a set of web components, meaning developers can use the toolkit no matter what tech stack (React, Vue, Svelte, etc.) their extension is built with.
22
-
-**Accessible out of the box:** All components ship with web standard compliant ARIA labels and keyboard navigation.
19
+
-**Implements the Jupyter design language:** All components follow the design language of Jupyter – enabling developers to create extensions that have a consistent look and feel with the rest of the ecosystem.
20
+
-**Automatic support for color themes:** All components are designed with theming in mind and will automatically display the current application theme.
21
+
-**Use any tech stack:** The library ships as a set of web components, meaning developers can use the toolkit no matter what tech stack (React, Vue, Svelte, etc.) their extension is built with.
22
+
-**Accessible out of the box:** All components ship with web standard compliant ARIA labels and keyboard navigation.
23
23
24
24
Note this project started as a fork of the [WebView toolkit for Visual Studio Code](https://github.com/microsoft/vscode-webview-ui-toolkit) (licensed under MIT) on which Jupyter design specification. The fundamental technology used is [Fast Design](https://www.fast.design/).
0 commit comments