Skip to content

Latest commit

 

History

History
16 lines (10 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

16 lines (10 loc) · 1.25 KB

Contributing To This Project

We highly encourage contributions to this project and welcome PRs.

Familiarity with fastpages is helpful. All you need to do is include the appropriate front matter in your notebook. See this guide.

A good pull request to emulate is this one - study the Jupyter notebook closely, especially the first cell that specifies the metadata, and how cells are hidden with #hide or #hide_input.

You should preview your dashboard locally by following the Development Guide, before submitting a PR.

Guildelines For New Dashboards

  • Your dashboard should not duplicate or present substantially the same information to what already exists in other dashboards.
  • Any technical information and notes should go in an appendix.
  • Make the visualization as approachable as possible. Explain things in plain english. Font sizes should be easy to read.
  • Put your main visualization at the top of your notebook. The methodology or "how to" should either be in footnotes or hidden from view.