Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 1.77 KB

How-to-Contribute-Review-Science-Design.md

File metadata and controls

27 lines (19 loc) · 1.77 KB

Review or Contribute to a Science Design

All moja global code is informed by a Science Design. Science Designs are developed collaboratively and everybody is invited to contribute. It is advisable to review the science design before contributing to the code or the documentation. Follow the following steps to contribute to or review a Science Design:

  1. Find the Science Design:

    • Every moja global repository has a sub-directory called Science in the root directory.
    • The Science folder contains two types of Science Designs:
      • PDF files contain completed science designs.
      • Markdown files contain a link to Science Design under development.
    • Locate the PDF file with the highest version number for review.
    • Locate the Markdown file with the highest version number for a contribution.
    • If no Markdown file is available, proceed with agreeing on a Science Design.

  2. Review Science Design:

    • Open the PDF file you plan to review.
    • Changes or suggestions are not possible.
    • If you find an inaccuracy or want to propose an improvement, check whether your change has already been made in the Markdown file with the higher version number.
    • If the change has not been made yet, continue with the contribution to a Science Design below.

  3. Contribute to a Science Design:

    • Open the Markdown file with the highest version number.
    • Follow the URL to the Google Doc with the ongoing science discussion.
    • Contact the Document Owner to join the discussion or just leave a comment in the text.