Skip to content

Submit a correction using GitHub pull requests

Lisa Cerrato edited this page Mar 22, 2018 · 1 revision

Making minor corrections to existing works.
Note, significant changes to an edition may call for a change to the file name. Please ask if you are unsure if you should be creating a new edition.

  1. Search open issues for your work. There may be work in progress related to your correction.
  2. If an existing issue has not been found, create an issue in the repo using a descriptive name:
    (file name) description
    e.g.
    (phi0978.phi001.perseus-lat1.xml) missing text
  3. Clone the repo and pull from Master.
  4. Create a branch from Master.
    e.g. phi0978.phi001 or phi0978.phi001_edits
  5. Make local corrections to the file on this new branch.
    Note for step 6: Not all users will have check in permissions. If you do not have check in permissions, simply skip to step 7.
  6. When checking in your edits, include the branch name and number of the issue created in step 1.
    e.g. (phi0978.phi001) added missing text #56
  7. View Hook tests for your check ins to confirm that all tests are passing.
    a. Go to repo page https://github.com/PerseusDL/canonical-latinLit
    b. Click on "coverage" at bottom of the page to go here http://ci.perseids.org/repo/PerseusDL/canonical-latinLit
    c. Look for your build and click on the Build number. This will take you to a Travis CI page with further Hook testing information.
    d. Look for your file name in the logs and see if it is passing.
  8. Create a Pull Request for your issue when are you done with your edits and all tests are passing.
    This can be done via the GitHub GUI, command line, or other software. In most cases, the repo home page will show you the most recent changes to your branches (Your recently pushed branches.) and have a Compare and Pull Request option at the top of the page that will open this option for you.
  9. On the Pull Request page, in the body of the Pull Request message say you are fixing the issue you created:
    (phi0978.phi001) added missing text
    fix #56
    This will enable the issue to be easily closed when the Pull Request is complete.
  10. Assign someone to review your Pull Request whenever possible.
    The reviewer may add comments and suggestions for making additional changes.
  11. Once the Pull Request is accepted, pull from Master. You may delete your branch. Your issue should now be closed.