Using GitHub

We use GitHub to manage our workflow and keep track of our updates to the website. While it might be a new tool for you, it helps us to organize and manage our work. You can always see requests you've made and who is assigned to work on your issue. Please reach out to any team member if you need assistance working with GitHub via GitHub or by email at onrrweb@onrr.gov.

Step 1: Create an account

Follow the directions on github to create an account.

Step 2: Sign up for email notifications

Once you set up your account, sign up for email notifications so you will receive notification of anything related to an issue you created or if someone else needs your help or review of an issue.

Step 3: Request an update to ONRR.gov

When you need to make an update to the site, go into GitHub and create a new issue. GitHub has instructions on creating issues if you need more help.

Once you create the issue, we will either make the requested change or reach out to you for clarification.

Once the change is made in the development site, we will comment on your issue with an @yourusername and the development site link.

You will receive an email that it is ready for your review so either respond to the email that you approve the change or comment back to us in GitHub that you approve the change and then we will go live. We will close the issue once the change is live on onrr.gov.

Best practices for writing your GitHub requests

When you are typing out your GitHub request, please keep in mind that the ODDD team is completing requests from every group within ONRR. We might not be as immediately familiar with the content you want updated/added as you, the Subject Matter Expert, are. Here are some guidelines to help make your instructions to us as clear as possible. Our goal here is to foster better communication!

Make sure your content is 508-compliant:

• Any content you want added/updated to the site needs to be Section 508 Compliant.
• Please do accessibility checks and make sure your content passes those checks BEFORE submitting a GitHub request.
• Here are our instructions for checking PDF accessibility.
• If your content is not accessible, you are required to make it accessible before we can post it on the website.

Direct us to the exact webpage you want updated:

• Please give us the url of the webpage you want updated.
• After the url, please detail where the content you want updated is located within the webpage.

When requesting existing content to be replaced/updated:

• Please be very clear which existing files/documentation/language/other content should be updated.
• Please reference the filename and/or hyperlink language currently on the webpage for that existing file.
• An example of GitHub request language (in addition to the exact webpage location instructions) would be "Please replace [oldfilename] with [newfilename]".
• Please be sure to do this with every file that needs to be updated, so that we can easily match what new files are replacing what old files. We want to make sure that there are no duplicate documents or old/outdated documents on the website.

When requesting new content be added to the site:

• Please be very clear on the location for where this new content should be added.
• Please give the exact language you want us to add to the site.
• If you are adding a new file or external url, please give the exact language for the hyperlink.
• Please provide detail for any formatting changes (bulleted lists, tables, etc). You can do a mock-up in a word document for us to show any specific formatting you want.