fund-indicators/CONTRIBUTING.md

How to Contribute

Did you come here to read what you should do before creating an issue? Scroll down!

How you can help

There are many ways to contribute to fund-indicators:

• Help with testing and reporting bugs
• Help write documentation
• Help implement new features
  • New sources of data
  • Better web scraping
  • Better statistical measures
  • Multithreading (asynchronous requests)

Filing an issue

Thanks for wanting to help out with squashing bugs and more by filing an issue.

There are a few things you might consider when filing your issue:

• What made the issue/bug appear? (steps to reproduce)
• Do you have the latest version of this program?

Getting started with development

To develop on fund-indicators you'll probably want to:

1. Read the code of conduct
2. Install normally, as documented in the README
3. Read the documentation (although it's not much)
4. Read the section above to understand the ways you could best help this project

Questions?

If you have any questions, please email fund-indicators@andrewkdinh.com.