*For this guide, please replace text surrounded by <>
with the appropriate text for each command. Do not include <>
characters in your commands.
git --version
If you do not have git on your machine, follow the installation instructions here
2. Fork your own copy of merl-center-public repository on GitHub by clicking the fork button in the top right corner of the repository page
git clone <your-fork-url>.git
cd MERL-Center-public
1a. Check if you have Docker installed locally. If you don't have Docker installed, follow the instructions here
docker -v
docker compose build
docker compose up
2a. Check if you have Ruby installed locally. If you don't have Ruby installed, follow the instructions here to install Ruby
ruby -v
gem install bundler
bundle install
bundle exec jekyll serve --livereload
git remote add upstream https://github.com/MERLCenter/MERL-Center-public.git
Verify that the origin remote points to your fork and the upstream remote points to the main repository
git remote -v
git config --add remote.upstream.fetch "+refs/pull/*/head:refs/remotes/upstream/pr/*"
This command adds additional fetch instructions to your .git/config
file so that you can more easily pull down branches from pull requests on the upstream repository
git switch main
git pull upstream main
4. Fetch all pull request data from the main repository using the upstream remote that was modified in step 8 of setting up your local dev environment
git fetch upstream
git checkout upstream/pr/<number>
npm run start
7. Navigate to localhost:4000
in your browser to check if the changes from the pull request are working as expected
You have three options for submitting feedback:
- Leave a comment on the pull request
- Approve the pull request which will allow for merging
- Request changes which will prevent pull request from being merged until changes are made and you re-review the pull request
git switch main
git pull upstream main
git checkout -b <relevant-branch-name>
git branch
5. Make necessary changes to code in order to satisfy the requirements of the issue you are working on
git add .
git commit -m "short descriptive commit message"
git push --set-upstream origin <relevant-branch-name>
Note: replace <relevent-branch-name>
with the name of the branch you created in step 3