Skip to content
Shauna edited this page Apr 27, 2019 · 20 revisions

Welcome

Hi, and thank you for sprinting with us! We're so happy to have your help.

Hopefully you've already met Shauna, who is the in person lead for the event. If not, please come say hi! The other two project leads are Chris and Matt, who will be participating remotely. You can communicate with them through the NumFocus Slack [note: link or find alternative].

To get started, try installing our project using the instructions in our quickstart guide. We hope they'll work flawlessly but if they don't, please let us know and together we can update our installation process and documentation, which is a fantastic contribution in its own right.

Tasks

Once you've got the project installed, you can start addressing one of our open issues. If you start working on one please leave a comment on it so we don't have multiple people working on the same thing without realizing it. Here's a list of tasks:

  • Test out our installation instructions on your machine: OverArk #28. No experience necessary.
  • Help fix stylistic issues with Flake8: Hark #262. No experience necessary.
  • Move our documentation into its own repo and set it up on ReadTheDocs with auto-updating: OverArk #3. Experience with ReadTheDocs helpful but not necessary.
  • Add attribute __version__ to module: Hark #221. No experience necessary, should be quick.
  • Help us expand our unit test coverage: Overark #18. Involves pairing with remote team member, should have some experience writing unit tests.

Tasks still to prep

  • Find a way to import only the needed parts of Latex for our Jupyter Notebooks: related to this issue but we need a clearer explanation for a newcomer, that's overwhelming as is. {CDC will edit/prep}
  • Implement linting and help us pass our linting tests. #171 - but note this isn't quite ready for newcomers, we need to make some high-level approach decisions. {SGM will edit/prep, and set up linting}
  • HARK must be used in a graphical environment? - A great issue for someone with experience configuring AWS or Google Cloud VM's but not much economics background
Clone this wiki locally