Skip to content

Commit 0e04265

Browse files
committed
Update contribution guide
1 parent 82aa024 commit 0e04265

File tree

1 file changed

+11
-23
lines changed

1 file changed

+11
-23
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,32 @@
1-
# Contributing to JupyterLab
1+
# Contributing to UI Toolkit for Jupyter
22

33
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
55
contributing!
66

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).
118

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)
1411
that we believe are good examples of small, self-contained changes. We
1512
encourage those that are new to the code base to implement and/or ask
1613
questions about these issues.
1714

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-
2615
## General Guidelines for Contributing
2716

2817
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).
3120

3221
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).
3423

35-
All source code is formatted using `prettier <https://prettier.io>`\_\_.
24+
All source code is formatted using [prettier](https://prettier.io).
3625
The benefit of using a code formatter like prettier is that it removes the topic of
3726
code style from the conversation when reviewing pull requests, thereby
3827
speeding up the review process.
3928

40-
You may use the prettier npm script (e.g. `npm run prettier` or
29+
You may use the prettier npm script (e.g.
4130
`yarn prettier`) to format the entire code base.
4231
We recommend installing a prettier extension for your code editor and
4332
configuring it to format your code with a keyboard shortcut or
@@ -48,8 +37,7 @@ automatically on save.
4837
Generally, an issue should be opened describing a piece of proposed work
4938
and the issues it solves before a pull request is opened.
5039

51-
Issue Management
52-
^^^^^^^^^^^^^^^^
40+
## Issue Management
5341

5442
Opening an issue lets community members participate in the design
5543
discussion, makes others aware of work being done, and sets the stage

0 commit comments

Comments
 (0)