-
Get added to the CMU Maps team.
-
Create a branch by clicking on the branch button, typing in a branch name, and clicking on create branch.
-
Create a codespace by clicking on the code button on the CMU Maps Repo and clicking the Codespaces tab. See image below:
-
Click on the plus button to create a GitHub code space in your branch that will appear in another tab.
-
Run this command GITHUB_TOKEN=$GH_TOKEN in the terminal
-
Run this command git submodule update --init --recursive in the terminal.
-
Run this command npm run dev in the terminal after this text pops up.
-
If you see that the program is running like below and you have CMU Maps running locally in the link given by "Local:", you are set up! If you want to work in VSCode though, continue to follow step 8.
-
Go back to the CMU Maps GitHub Repo and click on the code button, Codespaces tab, and find your code space.
-
Click on the three dots ". . ." and click from the dropdown options "Open in Visual Studio Code".
-
Accept all the pop ups for nessecary installation.
-
Locate the source control icon on the nav bar.
-
Type a decription of your change and hit commit.
-
Click on "yes" for staging all your changes.
-
Go back to the CMU Maps GitHub Repo and click on the "Compare & pull request.
-
Type a title and brief description of your pull request and click on "Create Pull Request".
