CorrelAid docs
  • Welcome
  • Wiki
    • How We work - Hitchhiker's Guide to CorrelAid
    • FAQ
    • Communication channels
      • Conference calls ​☎
      • Slack
      • Blog
    • Infrastructure
      • Newsletter: MailerLite
      • Google Workspace
      • Password management
      • Video conferences
      • Kobotoolbox for Forms
      • Gitbook for documentation
      • NextCloud
      • Azure & DNS management
      • CorrelBase (Metabase)
      • GitHub and GitLab
      • Directus (Content Management System)
      • Pretix
    • PR Guide
    • Design Guide
    • CorrelAid Merch
    • How to create an event
  • CorrelAidX Manual
    • What is CorrelAidX?
    • Get started!
      • Finding partners
      • E-mail templates to contact NPOs
      • Room booking and catering
    • Finding a legal form
    • Role definitions
    • Event formats
      • Data dialogue
      • Workshops
      • Introducing CorrelAid
      • Panel discussion
      • Hackathons
    • Cooperation Agreements
    • PR activities
    • Doing a project
    • Contact
  • Project manual
    • CorrelAid Data4Good projects
    • Toolbox
    • The Ethics Questionnaire and its Companion Document
    • Project coordination
      • Project Acquisition
      • Scoping & Call for Applications
      • Team selection
      • Onboarding
      • Kickoff
      • Project work
      • Handover workshop
      • Follow-up
      • Documentation
    • Team lead
    • For the project team
      • Project Follow-Up
      • Best practices
        • General/Collaboration
        • Dataviz / Reporting
        • Python
        • R
    • Data privacy & security
    • When do we do a project? When not?
  • CorrelAid Website
  • EDUCATION MANUAL
    • General
    • Educational Formats
      • R Lernen
      • Daten verstehen und nutzen
      • CorrelCompact
      • Community Workshops
    • For educational volunteers
      • Toolbox: Methods in live sessions
      • Guide to source citation and licences
Powered by GitBook

The CorrelAid Docs are licensed under CC-BY 4.0.

On this page
  • Collaboration
  • Definition of Done
  • General best practices
  • How to document code
  • Peer review

Was this helpful?

Edit on GitHub
Export as PDF
  1. Project manual
  2. For the project team
  3. Best practices

General/Collaboration

PreviousBest practicesNextDataviz / Reporting

Last updated 3 years ago

Was this helpful?

Collaboration

Definition of Done

We suggest you use a Definition of Done for your project. This gives everyone in the team an understanding when a task is really done.

You can find the CorrelAid Definition of Done here:

General best practices

Those general best practices should help you with implementing the items of the Definition of Done.

How to document code

Documenting your code should always be less about the "what" and more about the "why". However, if you are writing code which might be a bit more advanced/complex, adding some comments about how it works is also useful, especially for the less experienced team members.

Peer review

Peer reviewing someone else's code involves three things:

  1. test the code on your machine

  2. provide feedback (possibly suggesting changes)

If a team member is still quite new to Git, a file-driven "review process" (e.g. data_cleaning_jack.R) is also acceptable as to not overwhelm them with Git. You can leave comments in the file and commit it back to Git or discuss your feedback in a GitHub issue. Always be kind to team members with less experience.

Whenever the skills of the team allow for it, you should use and for this. are a great way to directly suggest changes.

branches
pull requests
Pull request reviews
LogoGitHub - CorrelAid/definition-of-done: Definition of Done for CorrelAid projectsGitHub