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

Add a README file to each package #339

Open
afshin opened this issue Aug 8, 2022 · 6 comments
Open

Add a README file to each package #339

afshin opened this issue Aug 8, 2022 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Please work on this if you are interested
Milestone

Comments

@afshin
Copy link
Member

afshin commented Aug 8, 2022

We should have at least a basic REAMDE.md file in each Lumino package. In addition to helping new contributors navigate this mono-repo, it also allows the NPM page for each Lumino package to display some useful information to consumers of the package.

@afshin afshin added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Please work on this if you are interested labels Aug 8, 2022
@afshin afshin added this to the Lumino 2 milestone Aug 8, 2022
@gabalafou
Copy link
Contributor

As far as I can tell, none of the packages currently have a README.md. If somebody could make a README for one package, I could use that as a template to make more for other packages.

@fcollonval
Copy link
Member

Something like the following would be nice


@lumino/application

A Lumino package to create web application composed of plug-able plugins.

By default, it contains a CommandRegistry using @lumino/commands, a ContextMenu and a view called shell that must inherits from Widget class (the two later classes are defined in @lumino/widgets).

@gabalafou
Copy link
Contributor

Thanks for the template @fcollonval, I'll work on extending this template to all of the Lumino packages. I don't have permission to assign this task to myself. Could you assign it to me? Thank you!

@afshin
Copy link
Member Author

afshin commented Aug 19, 2022

@gabalafou I've added you to the "Triage" team for the jupyterlab GitHub org, you should be able to assign and label things, etc., now

@gabalafou
Copy link
Contributor

Just a heads up that I won't be able to work on this until next week.

@gabalafou
Copy link
Contributor

I'm punting on this for another week because I wanted to finish #332.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Please work on this if you are interested
Projects
No open projects
Status: not started
Development

No branches or pull requests

3 participants