Saltar al contenido principal

Documentation Contributions

Documentation acquires utmost necessity in Software development to ensure that everyone is on the same page. With documentation, you can ensure that the code base remains accessible and understandable in the longer run. It would also allow coaches and ambassadors to onboard new contributors quickly, as documentation provides a quick start to the whole project.

Documentation levels

We have five levels of documentation at moja global which we employ to document our code:

  1. Documentation in the code base:

    • Before commenting in the code try to clarify the code with better naming and structuring.
    • Use comments to provide context to the reader of the code.
    • Ensure comments are easy to maintain and understand.

  2. Documentation in Markdown files:

    • Use Markdown files for documentation that needs to be reviewed by maintainers before it is changed. It includes:
      • How-To information
      • Plans
      • Procedures
      • Governance documents
    • Submit changes using a pull-request which would be reviewed and merged.

  3. Documentation in the repository Wiki:

    • Use the repository Wiki for information that can be changed by all collaborators without review, including:
      • Tutorials
      • Explanations
      • Reference Information
    • Make changes and commit directly to the Wiki.

  4. Documentation in Google Docs:

    • Use Google Docs for the collaborative development of documents (text equivalent of features branches), including:
      • Science Designs
      • Architecture
      • Strategy
    • Make changes in accordance with the guidelines provided in the document.

  5. Documentation in PDF files

    • Use PDF-files for documentation that should not be changed (text equivalent of a release), including:
      • Science Designs
      • Architecture
      • Strategy
      • Meeting notes
    • Errors can be pointed out to the document maintainer. All other changes can only be made in the next version which is still open in Google Docs.

Translations

moja global wants to reach as many people as possible including those who do not speak English well. This is our approach to translations:

  1. User Interface

    • Please contact the Maintainer of the User Interface Repository.
    • More information will be made available when the User Interface further advances.

  2. Wiki and user info

    • moja global wants all info to be available in all languages BUT maintaining information across various languages is hard and time-consuming.
    • Please use the Translate function available through your browser to translate pages on GitHub or the Website.
    • Please advise on how we can facilitate contributions from those who are not comfortable with English.

If you have experience and want to help, please send an email to mentorship@moja.global.

User Feedback

moja global is increasingly looking for new scientists, developers and researchers to join us and help improve our processes. We are also looking for constructive feedback to help us improve our software, workflows and processes. Please have a look at the below steps to get started with sharing your feedback as a user:

  1. Navigate to the landing page of the repository on which you want to provide feedback. If you have feedback on moja global, please navigate to the About_moja_global repository.
  2. Under the repository name, click Issues.
  3. Click the green New Issue button.
  4. Click the green Get Started button in the User Feedback box.
  5. Use a clear and descriptive title.
  6. Follow the template and provide as much information as possible.
  7. Attach files, screenshots and/or animated GIFs.
  8. Click the green button Submit New Issue at the bottom right corner.

If the feedback is related to Code please also review:

Answer user questions

moja global projects are available to Users under a License that allows them to use the project and suggest ways to improve the same. These suggestions are posed either as a question or as feedback and need to be addressed by the Maintainers and the Coaches. To answer User Questions effectively, we have the following steps that we would like to be followed:

  1. Join moja global by following these steps.
  2. Review open issues on your repository and segregate them according to their priority and intent. Assign a priority to each issue using the issue labels: Priority = High, Priority = Medium and Priority = Low.
  3. Review the team discussions for your project, repository or moja global.
  4. Review the discussions on moja global's Slack workspace.
  5. If the reply could be useful for others, create an entry under the FAQ section on the Wiki of your repository or in this wiki for general questions in and around moja global.
  6. Finally, claim appropriate credit for your contribution by following these steps.