⇦ Back to: Every coder needs a VCS | ⇧ Overview | ⇨ Next: Issue

You’ll need:

• a GitHub account (get one here: https://github.com/, you’ll need this for submitting change requests)
• a text editor:
  • VSCode is commonly used and a pretty good general text editor.
  • RStudio is popular for projects using the R Programming Language
• a way to clone and commit to the repository:
  • the GitHub Desktop app (recommended for Windows and macOS), or
  • the GitHub plugin for VSCode (recommended for Windows, macOS and Linux)
  • RStudio with the Git command line tool git and the Git credential manager (recommended when using RStudio on Oscar)
  • the GitHub Command Line Tool gh and the Git command line tool git (recommended when using RStudio on Windows, macOS and Linux), or
  • open the repository in a codespace on GitHub,

Get this working on OSCAR at Brown University

<aside> ✅ Prerequisites: A working OSCAR setup

</aside>

Option: Use VSCode and some plugins

• Open the Open On Demand Desktop App: (https://ood.ccv.brown.edu/)
• Load the modules git/2.29.2, vscode/1.68, firefox/87.0
• Open VSCode using code --no-sandbox
• Add the following Extensions to VSCode:
  • “GitHub Pull Requests and Issues”
  • (Optional:) Git Graph
  • (Optional:) Git Lens
• Clone the Git Repository – from the Start page of VSCode, click “Clone Git Repository” and paste the URL https://github.com/brown-ccv/how-to-pr
• Deal with any authentication issues which arise.

Option: Use the gh command line tool

<aside> 🤸 This is tricky, as gh isn’t currently available as a module on OSCAR. You can install it as a conda package though.

</aside>

• Create and activate a new conda environment using the instructions here: https://docs.ccv.brown.edu/oscar/software/anaconda
• Install gh and git from the conda-forge channel.