Skip to content

GitHub Workflow

Jump to bottom
Jason Kiesling edited this page Mar 29, 2019 · 9 revisions

THIS PAGE IS A WORK IN PROGRESS

If something seems wrong or doesn't make sense, I'm sorry. --Jason

MYR has two main GitHub branches. These are master and dev. Both are restricted to only allow commits via approved pull requests.

  • Master is the current source code for MYR. It has gone through testing and is fully functional. It is deployed to learnmyr.org
  • Dev is the source code that is currently undergoing final tests. It is deployed to dev.learnmyr.org.

Getting Started

  1. Visit github.com/isenseDev/MYR. In the top right corner, click "Fork" and follow the directions.
  2. On your computer, run the following commands. (This requires git to be installed.)
git clone https://github.com/[your-username]/MYR.git  
cd MYR  
git remote add upstream https://github.com/isenseDev/MYR.git

Submitting Code

  1. Ensure that your code is committed and pushed to your repo.
  2. Create a pull request at github.com/isenseDev/MYR/pulls.
  3. If there is a yellow prompt to create a pull request from your fork, click that button. Otherwise, click the button that says "New pull request".
  4. Ensure that you are pulling from the correct branch on your fork into the dev branch of the isenseDev/MYR base repository.
  5. Create a title that is informative to your changes. If you need to explain more than you can in the title, make comments in the description.
  6. Request a review from members of the MYR team.
  7. Add the pull request to the MYR project on the sidebar.
  8. Add any appropriate labels.
  9. Add the pull request to the MYR project.
  10. Resolve any merge conflicts.
  11. Click the button at the bottom to create a pull request.

Approving a Pull Request into Dev

  1. Look at the files changed to see if there are any obvious issues.
  2. Pull the changes to your local repository to check for errors.
git remote add [username] https://github.com/[username]/MYR.git
git pull [username] [branch-name]
  1. Run the code and test it.
  2. Click the review changes in the top right corner.
  3. If you had issues, click request changes. If it worked, click approve.
  4. Create a comment explaining what you found and what system you tested it on.
  5. If the changes are ready to be merged into dev, click "merge changes" at the bottom of the screen.
Clone this wiki locally