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

Lerna Documentation For Development #629

Open
gwincr11 opened this issue Oct 17, 2022 · 3 comments
Open

Lerna Documentation For Development #629

gwincr11 opened this issue Oct 17, 2022 · 3 comments

Comments

@gwincr11
Copy link
Contributor

gwincr11 commented Oct 17, 2022

👋 I am working on some of the npm packages to add some lazy evaluation and other features we discussed. I am running into issues with Typescript not properly finding the nbdime packaged when building the webapp and lab packages. I am also not sure of the best ways to interact with the local server when altering things locally.

It would be great to document some of the common development patters around this and would unblock us from making some improvements to nbdime. Thanks ❤️

cc @vidartf

@vidartf
Copy link
Collaborator

vidartf commented Oct 21, 2022

Do you have some examples of some cases/patterns? It would help me better understand what level om details would be most helpful here.

@gwincr11
Copy link
Contributor Author

Thanks,

I think it would be helpful to have docs around:

  1. Setting up the javascript environment for development
  2. Compiling typescript for each package
  3. Running the server locally to test changes
  4. Running the tests for each package

An example would be, I want to alter the javascript for the UI, how do I install the code locally, where do I alter the code, how can I compile and test the changes.

I am also wondering if you would be open to us putting codespaces dev container into this project so people can jump into a pre-configured environment to help with some of the install?

@gwincr11
Copy link
Contributor Author

It would also be helpful to document how to point jupyter lab at a local nbdime path.

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

No branches or pull requests

2 participants