How to use Git and GitHub

How to add changes to the internal wiki with Codespaces

  1. If you haven't already opened a Codespace, open a new Codespace, otherwise, you can reuse the Codespace you already have open.
  2. Open up the internal wiki on Codespaces.
  3. Before you add any changes, run git pull. This ensures that your local version of the internal wiki is updated with other people's changes. If you don't do this step you make end up with merge conflicts. If running git pull results in merge conflicts (it shouldn't if you're always running git pull), let Lucy or a wiki liaison know.
  4. Make a new branch git branch [name-subteam-description]. Then switch to that branch, git checkout [name-subteam-description]. Someone would run:
git branch lucy-drylab-software
git checkout lucy-drylab-software
  1. Make your changes in markdown; make sure to preview to ensure your edits are properly formatted.
  2. When you are ready to publish your updates, you will need to save your files. In git, this is called making a commit. Git provides finer grain control, meaning you can choose which files to save in a project; most of the time you want to save all the files you have modified. Run git add .. This adds all modified and created files to the staging area.
  3. Once you are satisfied with the files in the staging area, run git commit -m "[message]". Replace [message] with a meaningful message related to your changes.
  4. Finally, you can run git push. Make sure you are pushing to the UBC iGEM repo, if asked where to push, push to the repo with the link [https://github.com/UBC-iGEM/internal-wiki-2023-24]; you can push to your own fork, but please enable this setting.
  5. Following the prompts on Codespaces or the GitHub website, make a PR. That's it! Leads and wiki liaisons will check your content and approve and merge your PR.

How add changes to the internal wiki with Replit

How to run the internal wiki on Replit

### How to push changes to internal wiki on Replit

How to use mdBook locally

If you want to have the full functionality of mdbook, please ask Lucy for instructions on local installation.