Skip to content
Shauna edited this page Jul 5, 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. To talk with them, please join us in our EconArk Slack by signing up here.

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.
  • Help us expand our unit test coverage: OverArk #18. Involves pairing with remote team member, should have some experience writing unit tests.
  • Help us automatically run jupyter notebooks as part of our test coverage: OverArk #29. Experience with Travis/CI needed.
  • Help us determine how to use HARK's graphical capabilities in a VM and/or help us save graphics without viewing them. HARK #199. Experience configuring configuring AWS or Google Cloud VMs needed.
  • Add type checks for some of our classes: HARK #190. Understanding of type checking helpful but not necessary.
  • Make the init methods in a family of classes more Pythonic by eliminating repetitive code that merely stores arguments as attributes: HARK #228
  • Correctly represent a kinked function with a piecewise cubic interpolator. Graduate-level economics background helpful to understand what's going on, but probably not required. HARK #103

Finished tasks!

  • Add attribute __version__ to module: HARK #221. No experience necessary, should be quick.
Clone this wiki locally