Conventions

Needs editing - copied from wiki

Data Loading Template

Nodes and Relationships

  • See Naming conventions for the suggested naming conventions for the nodes and relationships you create.

Look and Feel

Documentation

  • Documentation that is specific to a repo should be contained in that repo's README.
  • The main documentation wiki is for project level or general guidance.
  • Any questions or bugs about a specific repo should be raised through ZenHub and logged against the relevant repo.
  • If you feel you have any general, helpful queries or tips please add these to a suitable place in the main wiki.
  • Markdown is preferred as this will allow documentation to be consistently extracted via the GitHub API

Issue Labels

The standard GitHub labels are used along with several custom labels. Please note the following conventions when using labels:

  • data source - please only use this label to tag an epic as an actual data source. Related issues can be linked to the epic.
  • suggested - please use this label to tag suggested data sources. If you use the Data Source template this will be automatically added.
  • use case - please only use this label to tag an epic as an actual use case. Related issues can be linked to the epic.
  • numeric - this is used to tag a data source as numeric. The focus of CovidGraph is not necessarily to replicate many of the existing websites and dashboards presenting numeric data but feel free to log and tag as numeric any such data sources as there may be a use for them.