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

Modernize README #1238

Open
deppen8 opened this issue Sep 10, 2021 · 1 comment
Open

Modernize README #1238

deppen8 opened this issue Sep 10, 2021 · 1 comment
Labels
type:discussion Discussion or feedback about the lesson type:enhancement Propose enhancement to the lesson

Comments

@deppen8
Copy link
Contributor

deppen8 commented Sep 10, 2021

The README is pretty sparse. Some other lessons have more details in their README that we could use for inspiration.

In particular, I think it would be good to call out how folks can contribute and where to find good first issues. Happy to get other ideas too.

@deppen8 deppen8 added type:enhancement Propose enhancement to the lesson type:discussion Discussion or feedback about the lesson labels Sep 10, 2021
@gcapes
Copy link
Contributor

gcapes commented Sep 10, 2021

I looked at the python lesson's README. I think they've gone a bit overboard, but we should probably steal the section on using GitHub.

I think this is something a lot of new contributors struggle with.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:discussion Discussion or feedback about the lesson type:enhancement Propose enhancement to the lesson
Projects
None yet
Development

No branches or pull requests

2 participants