Skip to content

Latest commit

 

History

History
85 lines (60 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

85 lines (60 loc) · 2.79 KB
Raw

Contributing Guide

Now is the time the be ambitious with submissions. We can separate things out later, but for now I see no reason not to include Python type definitions.

Using DCO to sign your commits

All commits must be signed with a DCO signature to avoid being flagged by the DCO Bot. This means that your commit log message must contain a line that looks like the following one, with your actual name and email address:

Signed-off-by: John Doe <[email protected]>

Adding the -s flag to your git commit will add that line automatically. You can also add it manually as part of your commit log message or add it afterwards with git commit --amend -s.

Development Installation

Install the python. This will also build the TS package.

pip install -e ".[test, examples]"

When developing your extensions, you need to manually enable your extensions with the notebook / lab frontend. For lab, this is done by the command:

jupyter labextension develop --overwrite .
yarn run build

For classic notebook, you need to run:

jupyter nbextension install --sys-prefix --symlink --overwrite --py jupyter_fdc3_widgets
jupyter nbextension enable --sys-prefix --py jupyter_fdc3_widgets

Note that the --symlink flag doesn't work on Windows, so you will here have to run the install command every time that you rebuild your extension. For certain installations you might also need another flag instead of --sys-prefix, but we won't cover the meaning of those flags here.

How to see your changes

Typescript:

If you use JupyterLab to develop then you can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the widget.

# Watch the source directory in one terminal, automatically rebuilding when needed
yarn run watch
# Run JupyterLab in another terminal
jupyter lab

After a change wait for the build to finish and then refresh your browser and the changes should take effect.

Python:

If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.

Updating the version

To update the version, install tbump and use it to bump the version. By default it will also create a tag.

pip install tbump
tbump <new-version>

Style

  • Use fdc3. to make all fdc3 calls within your models. This makes it easier to read whether or not something is a class method without relying on specific syntax. If there are bundle size implications we would be happy to reconsider. I have only checked briefly and saw no improvements.
// DO
import * as fdc3 from '@finos/fdc3'

await fdc3.getCurrentChannel()
// DO NOT
import { getCurrentChannel } from '@finos/fdc3'

await getCurrentChannel()