## Practical Intro AncientMetagenomeDir Github Pull Request Review <!-- Put the link to this slide here so people can follow --> Slides: https://hackmd.io/@jfy133/B156Z2mfP --- ### Scope - Not technical - i.e. not for computer-scientists - All through github website - What things to check for AncientMetagenomeDir --- ### Recap: What is a Pull Request? > "Pull requests let you tell others about changes you've pushed to a branch in a repository on GitHub. Once a pull request is opened, you can discuss and review the potential changes with collaborators and add follow-up commits before your changes are merged into the base branch." From [Github Documentation](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) --- ### TL;DR: What is a Pull Request "Are my proposed changes/additions cool to the main code base?" **PR _review_**: basically peer-review as we do for journals (and just as for 'free' :wink:) --- #### PR Review for AncientMetagenomeDir - Basic - Are all fields/columns filled? - Does the new entries follow standards in a list's README? - Standard - Basic + - Does the added entries match the original publication? - Gold Star - Standard + - Check for improved metadata (e.g. newer dates, locations) --- # How to PR Review --- ### Pull Request Tab <p> <a href="https://github.com/SPAAM-workshop/AncientMetagenomeDir/pulls"> <img src="https://github.com/SPAAM-workshop/AncientMetagenomeDir/raw/master/assets/tutorials/intro-to-github-ancientmetagenomedir-prreview/00-pr-tab.png" width=65%></img> </a> </p> Click :point_up: --- ### An Open PR <p> <img src="https://github.com/SPAAM-workshop/AncientMetagenomeDir/raw/master/assets/tutorials/intro-to-github-ancientmetagenomedir-prreview/01-open-pr.png" width=75%></img> </p> --- ### PR Checklist <p> <img src="https://github.com/SPAAM-workshop/AncientMetagenomeDir/raw/master/assets/tutorials/intro-to-github-ancientmetagenomedir-prreview/03-pr-checklist.png" width=75%></img> </p> --- ### Starting a Review <p> <img src="https://github.com/SPAAM-workshop/AncientMetagenomeDir/raw/master/assets/tutorials/intro-to-github-ancientmetagenomedir-prreview/02-review-page.png" width=75%></img> </p> --- ### Adding a Single Comment <p> <img src="https://github.com/SPAAM-workshop/AncientMetagenomeDir/raw/master/assets/tutorials/intro-to-github-ancientmetagenomedir-prreview/04-add-comment.png" width=75%></img> </p> --- ### Add Suggestion <p> <img src="https://github.com/SPAAM-workshop/AncientMetagenomeDir/raw/master/assets/tutorials/intro-to-github-ancientmetagenomedir-prreview/05-add-suggestion.png" width=75%></img> </p> --- ### Preview Suggestion <p> <img src="https://github.com/SPAAM-workshop/AncientMetagenomeDir/raw/master/assets/tutorials/intro-to-github-ancientmetagenomedir-prreview/06-preview-suggestion.png" width=75%></img> </p> --- ### Viewed File <p> <img src="https://github.com/SPAAM-workshop/AncientMetagenomeDir/raw/master/assets/tutorials/intro-to-github-ancientmetagenomedir-prreview/07-viewed-file.png" width=75%></img> </p> --- ### Final Review Summary <p> <img src="https://github.com/SPAAM-workshop/AncientMetagenomeDir/raw/master/assets/tutorials/intro-to-github-ancientmetagenomedir-prreview/08-finalised-pr.png" width=75%></img> </p> --- ### Review Icons <p> <img src="https://github.com/SPAAM-workshop/AncientMetagenomeDir/raw/master/assets/tutorials/intro-to-github-ancientmetagenomedir-prreview/09-review-icons.png" width=75%></img> </p> --- ### Author View of Review <p> <img src="https://github.com/SPAAM-workshop/AncientMetagenomeDir/raw/master/assets/tutorials/intro-to-github-ancientmetagenomedir-prreview/10-review-to-author.png" width=75%></img> </p> --- ## Rinse and Repeat! --- ### Thank you! :sheep: You can find me on - GitHub (jfy133) - Slack - or email me