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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-23Lines changed: 11 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,43 +1,32 @@
1
-
# Contributing to JupyterLab
1
+
# Contributing to UI Toolkit for Jupyter
2
2
3
3
If you're reading this section, you're probably interested in
4
-
contributing to JupyterLab. Welcome and thanks for your interest in
4
+
contributing to UI Toolkit for Jupyter. Welcome and thanks for your interest in
5
5
contributing!
6
6
7
-
Please take a look at the Contributor documentation, familiarize
8
-
yourself with using JupyterLab, and introduce yourself to the community
9
-
(on the mailing list or discourse) and share what area of the project
10
-
you are interested in working on. Please also see the Jupyter `Community Guides <https://jupyter.readthedocs.io/en/latest/community/content-community.html>`\_\_.
7
+
Please take a look at the Contributor documentation and see the Jupyter [Community Guides](https://jupyter.readthedocs.io/en/latest/community/content-community.html).
11
8
12
-
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>`**
9
+
We have labeled some issues as [good first issue](https://github.com/jupyterlab-contrib/jupyter-ui-toolkit/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
10
+
or [help wanted](https://github.com/jupyterlab/jupyterlab/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
14
11
that we believe are good examples of small, self-contained changes. We
15
12
encourage those that are new to the code base to implement and/or ask
16
13
questions about these issues.
17
14
18
-
If you believe you’ve found a security vulnerability in JupyterLab or
19
-
any Jupyter project, please report it to security@ipython.org. If you
20
-
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>`\_\_.
21
-
22
-
.. contents:: Table of contents
23
-
:local:
24
-
:depth: 1
25
-
26
15
## General Guidelines for Contributing
27
16
28
17
For general documentation about contributing to Jupyter projects, see
29
-
the `Project Jupyter Contributor Documentation <https://jupyter.readthedocs.io/en/latest/contributing/content-contributor.html>`**
30
-
and `Code of Conduct <https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md>`**.
18
+
the [Project Jupyter Contributor Documentation](https://jupyter.readthedocs.io/en/latest/contributing/content-contributor.html)
19
+
and [Code of Conduct](https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md).
31
20
32
21
All source code is written in
33
-
`TypeScript <https://www.typescriptlang.org/Handbook>`**. See the `Style Guide <https://github.com/jupyterlab/jupyterlab/wiki/TypeScript-Style-Guide>`**.
22
+
[TypeScript](https://www.typescriptlang.org/Handbook). See the [Style Guide](https://github.com/jupyterlab/jupyterlab/wiki/TypeScript-Style-Guide).
34
23
35
-
All source code is formatted using `prettier <https://prettier.io>`\_\_.
24
+
All source code is formatted using [prettier](https://prettier.io).
36
25
The benefit of using a code formatter like prettier is that it removes the topic of
37
26
code style from the conversation when reviewing pull requests, thereby
38
27
speeding up the review process.
39
28
40
-
You may use the prettier npm script (e.g. `npm run prettier` or
29
+
You may use the prettier npm script (e.g.
41
30
`yarn prettier`) to format the entire code base.
42
31
We recommend installing a prettier extension for your code editor and
43
32
configuring it to format your code with a keyboard shortcut or
@@ -48,8 +37,7 @@ automatically on save.
48
37
Generally, an issue should be opened describing a piece of proposed work
49
38
and the issues it solves before a pull request is opened.
50
39
51
-
Issue Management
52
-
^^^^^^^^^^^^^^^^
40
+
## Issue Management
53
41
54
42
Opening an issue lets community members participate in the design
55
43
discussion, makes others aware of work being done, and sets the stage
0 commit comments