contributor guidelines

[mastoffel]

Create extensive contributor guidelines to make sure AutoEmulate can live on after the Turing project ends.

• installing the package
• overview, tools and style
• how to add emulators
• how to test
• contributor FAQ

[aranas]

brainstorming a list of specs that should go into a technical contributors guide:

• pre-requisite knowledge
  • What does a contributor need to know about emulation?
  • What does a contributor need to know about autoemulate past design choices that is relevant (eg temporal dimension needs to be collated)?
  • which parts of the package are modularized
• coding style
  • variable names
  • code repetition
• development environment
• model
  • Define a generic model class (minimum initialisation, minimum methods eg fit predict etc)
  • Which models should be added? (spatio-temporal? interpolation vs forecasting? black box vs grey box?)
  • pathway to get feedback if unsure if model is suitable
• checklist for contributing new model
• tests required
• documentation requirements

[aranas]

example guides:

• ruby on rails contributor guidelines