Skip to content

How to upload your changes to GitHub

Sklore edited this page Oct 11, 2016 · 1 revision

There are a few ways to work with GitHub but one of the simplest ways is to use the web site. The instructions below will document the steps required to upload your changes to the GitHub repository ensuring the changes are released with the 5e Community Pack.

This tutorial assumes you have already made the necessary changes within the Hero Labs editor and have saved your changes.

  1. Browse to: https://github.com/Sklore/HL_DD_5e_Colab
  2. From the 'Branch: master' drop it down and in the 'Find or create branch...' text box type your username and date (example: daplunk 12102016). This can technically be anything you like. What you are doing is creating a unique copy of the entire 5e Community Pack within which you will make your changes.
  3. You should see that the 'Branch:' button has updated to reflect the name you entered in step 2.
  4. Locate the file you have made changes to and click it.
  5. You will now see a screen with the contents of the file displayed. Click the edit icon on the right (little pencil).
  6. Open the file you edited within the Hero Lab Editor in Notepad (personally I prefer Notepadd++) and copy the entire contents of the file.
  7. Paste the contents of the file into the GitHub edit file screen replacing all other content.
  8. IMPORTANT: In the Commit changes option at the bottom of the edit screen; enter a description about the changes you have made. This is important as it assists us quickly identify changes for patch notes etc. We need to know what you changes and why you changed it.
  9. Click the Commit Changes button.
  10. You have now committed your changes to branch that you made. You can repeat the steps above if you are making changes to multiple files at the same time. Once you have committed all the necessary changes to your branch proceed to the next step.
  11. Go back to the top level of your branch. You can do this by clicking the 'HL_DD_5e_Colab' URL next to the 'Branch: ' button. Ensure the branch name matches the branch you created and is not the master.
  12. A highlighted section should now be apparent on this page for recently pushed branches. Click the 'Compare & pull request' button.
  13. A test will be made, ensure a green 'Able to merge' appears. This ensures no one else has modified the same file you are making changes to.
  14. Click 'Create pull request'.
  15. Click 'Merge pull request'. This will merge your changes into the master branch. You changes have now been merged into the master branch and will be released with the next official update to the 5e Community Pack.