git-good-research

A workshop for how to use git in a research environment

Git Basics

• Master is your main branch
• Create a new branch
• Make your changes
• Pull request
• Review
• Merge

Lab Books/Markdown

Markdown is a super versatile plain text markdown language. It supports a range of formatting options, you can see more here!

Markdown is widely supported on many services and you can use it to write notes, make slide decks using mdx-deck, websites and can easily be converted to pdfs. This readme is written in markdown!

Writing lab notebooks and manuals is great in markdown as its clean and clear, its also easy to edit and share.

Collaboration

Using issues and pull requests makes it easy to collaborate. Open issues to raise point, discuss new features or to comment on existing work. Use pull requests to comment on changes before they are merged

Feedback and Review

Approvals

GitHub can be set up so pull requests require approval before merging is allowed, you can also request a reviewer to approve your changes.

Projects

Projects are kanban style bords for your repos. They can automatically open new cards for new issues and pull requests and allow you to mange your project easily.

Traceablity

You can always check who changed what. Every commit has a user that made the changes and a full history is avalible in every repo copy

Overleaf

Overleaf has excellent GitHub intigrations, allowing you to push and pull all your changes to a central repo.

Resources

https://uc3.cdlib.org/2014/05/05/github-a-primer-for-researchers/

http://blog.martinfenner.org/2014/08/25/using-microsoft-word-with-git/

https://guides.github.com/features/mastering-markdown/

https://ohshitgit.com/