Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: extending README.md with the development section #61

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mrakitin
Copy link

I noticed that there is no Development section in the README.md file. This PR attempts to fix it (based on jupyterlab-google-drive and a little on ipysheet).

Copy link
Member

@ian-r-rose ian-r-rose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @mrakitin! I just had one minor comment.

```bash
jupyter lab --watch
```
This will automatically recompile `@jupyterlab/github` upon changes, and
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The jupyter lab --watch process won't automatically recompile the extension typescript sources, it instead watches the built JS. So you still need to watch or recompile the extension for JupyterLab to pick up the changes.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review, @ian-r-rose! What would you recommend then? jupyter lab --watch --dev-mode? Or another step for recompilation?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not --dev-mode (which will run JupyterLab from master without extensions). Instead we can start a watch process in the jupyterlab-github directory (jlpm run watch), which will recompile the extension at the same time as the jupyter lab --watch process is going on, which will then pick up the changes to the compiled sources.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants