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 more explicit steps to the Getting Started example #114

Open
willingc opened this issue May 20, 2021 · 2 comments
Open

Add more explicit steps to the Getting Started example #114

willingc opened this issue May 20, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers sprint-friendly A good issue for sprint events

Comments

@willingc
Copy link
Member

Improve the Getting Started section of the docs.

Right now it's easy to miss that two files are needed: a notebook (.ipynb file) to test and a test file (.py file) to write the tests.

It would also be helpful to add an explicit step on how to run the test file.

@willingc willingc added documentation Improvements or additions to documentation good first issue Good for newcomers sprint-friendly A good issue for sprint events labels May 20, 2021
@mmoralls
Copy link

Hello! I'm new to contributing and looking for something to work on. It looks like there hasn't been any progress as there isn't a Getting Started section.

@MSeal
Copy link
Member

MSeal commented May 20, 2021

Hello @mmoralls, the initial work on the project was mostly through Google Summer of Code, but it's had attention and improvements since then. We're outlining a range of issues for new contributors, especially with the PyLadies mentored sprint coming up this weekend. Tickets like this are to lower friction points for new contributors but it's certainly not a blocker to work on the project!

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 good first issue Good for newcomers sprint-friendly A good issue for sprint events
Projects
None yet
Development

No branches or pull requests

3 participants