jupyterlab/jupyterlab

Make typescript compilation more apparent for new contributors

Open

#5 840 ouverte le 6 janv. 2019

Voir sur GitHub
 (5 commentaires) (0 réactions) (0 assignés)TypeScript (13 454 stars) (2 937 forks)batch import
documentationgood first issuequestion

Description

When setting up to develop with Jupyter, I was not able to apply modifications to the packages directory while running in watch mode, jupyer lab --dev-mode --watch. Typescript changes would make the contents of my launcher not load in the Jupyter lab web application. Eventually, I read deeper into other developer documentation and found that I needed to compile typescript separately, or I would need to run jlpm run build after every typescript change. Would it be possible to either 1) integrate the typescript build into the webpack watch or 2) simply put this information in contributing.md to avoid confusing new contributors? Also, I still seem to have an issue if I do not build using jlpm run build for typescript changes.

Guide contributeur

Stack technique
typescriptjavascriptnodejs
Domaine
build systemdeveloper experiencedocumentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
TypeScriptNode.jsWebpackJupyterLab build process
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75
Direction de recherche
Investigate the current contributing.md and webpack configuration in the repository. Identify where information about TypeScript compilation is missing or unclear. Consider adding a section in contributing.md that explains the need to run jlpm run build after TypeScript changes, or explore integrating the TypeScript build into the webpack watch mode. Check existing discussions (e.g., issue #5840 comments) for any prior attempts or maintainer feedback.