Project Management and Collaboration

using GitHub


Ondřej Mottl

Science School of Quantitative Ecology 2024

Collaboration

This image was created by Scriberia for The Turing Way community and is used under a CC-BY licence

Collaboration types

This image was created by Scriberia for The Turing Way community and is used under a CC-BY licence

Collaboration forms

This image was created by Scriberia for The Turing Way community and is used under a CC-BY licence

Collaborate on a project

This image was created by Scriberia for The Turing Way community and is used under a CC-BY licence

Project communication plan

Plan.io

Project Management



wiki:

Project management is the process of leading work of a team … to achieve all project goals within the given constraints.

Project Management

Plan.io

Tasks management

Plan.io

What is a task?

Plan.io

Tasks management tools

Jory MacKay

A … task management tool … is your best friend when it comes to organizing, assigning, tracking, and reporting on tasks.

Plan.io

Best Practices

1. Split yout work into manageble chunks

Plan.io

Best Practices

2. Make your task atomic

It should be clear what is the goal and criteria of the task.


One chunk of work = one task

Best Practices

3. Set priority of tasks

Plan.io

Making a plan

Plan.io

Time management

Whole chapter in project management is dedicated to time management.

https://luxafor.com/ | Plan.io

Practical Exercise

03:00

What tools and methods do you use?

Project management tools

There are many tools for project management!!!

Google Keep

How to Use Google Keep to Create The Ultimate Task List

GitHub tools suite

wiki | Getting started with project planning on GitHub

Issue (a task) on GitHub

Original purpose of GitHub Issues is to track bugs & feature requests in software developmen projects🧑‍💻.

However, We can highjack it for any kind of task management👌🦹.

Software development life-cycle (SDLC)

Issue (a task) on GitHub

GitHub Docs

Note on Markdown

You can use Markdown in the description and comments

More details on Github Docs

Splitting tasks

You can split tasks into subtasks and checklists.

This allow to track progress more granularly.

GitHub Docs

Labels

You can use labels to categorize tasks.

GitHub Docs

Labels

Be crateative! You can create your own labels based on:

  • priority
  • type
  • status
  • …

GitHub Docs

Issues - Assign

GitHub Docs

Issues - space for communication

Rewind

Practical Exercise

03:00

  1. Look up issues on your favourite software (e.g. R package)
  2. Create an issue on your repo
  3. Make a comment

Tracking progress - link PRs

Issues can be linked to Pull Requests.

Link specific work with specific changes.

GitHub Docs

Tracking progress - link PRs

When a PR is merged, the issue is closed automatically.

Use the word close or fix in the PR description to link it to the issue.

The issue is closed by the PR

Tracking progress - Milestones

Plan.io

Tracking progress - Milestones

GitHub Docs

Tracking progress - Milestones

You can create a Milestone for:

  • Time frame - “2024-10-12”, “Conference XY”, …
  • Goal - “Methodology refactor”, “paper submission”, …
  • General topic - “Data cleaning”, “Data analysis”, …

GitHub Projects

GitHub Docs

GitHub Projects

You can organise your Issues and Pull Requests in Projects.

GitHub Docs

GitHub Projects

You can customise the columns in Projects with:

  • Labels
  • Linked Pull Requests
  • Milestones
  • …

GitHub Docs

GitHub Projects - custom views

GitHub Docs

GitHub Projects - custom views

GitHub Docs

GitHub Projects

There is so much more you can do with Projects:

  • Automations
  • Road maps
  • …

Check the official documentation

Practical Exercise

03:00

  1. Make some Issues in your repo
  2. Organise them in a Project

Dissemintation

https://www.teacherspayteachers.com/

Dissemintation

Ten Simple Rules for Taking Advantage of Git and GitHub

Dissemintation

GitHub uses git Tag and expand on it with Releases.

A Tag is a “frozen” state of repo at a certain time

A Release, based on a Tag, “packs” the whole repo into downloadable zip (with docs)

Git Tag - All You Need to Know | GitHub Docs

Open Data

Intermezzo

Sharing Data

Do you generate data and/or software?

  • Get a permanent URL to the repository as a Digital Object Identifier (DOI)
  • Deposit them in a “stable” repository (eg. Zenodo, Figshare, etc)
  • Included an example of how to cite it in the README or documentation

This image was created by Scriberia for The Turing Way community and is used under a CC-BY licence

FAIR Principles

Good practices for the management and administration of scientific data

“Access as open as possible, as closed as necessary”

  • Findable
  • Accesible
  • Interoperable
  • Reusable

This image was created by Scriberia for The Turing Way community and is used under a CC-BY licence

Open vs Close

This image was created by Scriberia for The Turing Way community and is used under a CC-BY licence

Licensing

ZENODO allows you to choose a licence for your data.

You can always share your private data and restricted access with the correct licence.

There are websites e.g. https://choosealicense.com/ to help on choosing a licence.

How to FAIR

Dissemintation - GitHub + ZENODO

Get DOI for your code and data with Zenodo.

Want a permanent DOI assigned to your data and code? | Zenodo

Data stewards

This image was created by Scriberia for The Turing Way community and is used under a CC-BY licence

Additional functions

of GitHub

Discussions

Project-specific space for communication on GitHub.

GitHub Docs

Discussions

Threads

Pools

GitHub Docs

Discussions

From Discussions to Issues.

GitHub Docs

Wikis

GitHub Docs

Practical Exercise

Brainstorm on how you could use Discussions and Wikis in

  1. your current projects
  2. future projects

03:00

Team administration

This image was created by Scriberia for The Turing Way community and is used under a CC-BY licence | Mentorship Structures

Team administration

Github allows you to manage your team by specifying roles and permissions.

GitHub Docs

Team administration

Best practices for organizations and teams using GitHub Enterprise Cloud

Team administration - Roles

GitHub Advanced Security — Secret Scanning

Team administration - Mentoring

This image was created by Scriberia for The Turing Way community and is used under a CC-BY licence

Practical Exercise

How would you desing a roles for your team/project?

03:00

GitHub Actions

Automate your works🤖!

Create a custom small program that will run on GitHub servers.

GitHub Actions

Usage examples:

  • run your script every day (e.g. to update data)
  • run your tests every time you push new code/data
  • render your website every time you update your content
  • …

Outro

This presentation

😸 Code on GitHub

🖥️ Slides

About me

Ondřej Mottl Assistant Professor at Charles University