Skip to content

Latest commit

 

History

History
103 lines (73 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

103 lines (73 loc) · 3.17 KB
Raw

Contributing

WARNING: This guide is a work in progress and will continue to evolve over time. If you have content to contribute, please refer to this document each time as things may have changed since the last time you contributed.

This warning will be removed once we have settled on a reasonable set of guidelines for contributions.

1 Fork the RedHatGov.io repo

Forking RedHatGov.io is a simple two-step process.

  1. On GitHub, navigate to the https://github.com/RedHatGov/redhatgov.github.io repo.
  2. In the top-right corner of the page, click Fork.

That's it! Now, you have a fork of the original RedHatGov/redhatgov.github.io repo.

2 Create a local clone of your fork

Right now, you have a fork of the RedHatGov.io repo, but you don't have the files in that repo on your computer. Let's create a clone of your fork locally on your computer.

git clone [email protected]:your-username/redhatgov.github.io.git
cd redhatgov.github.io

# Configure git to sync your fork with the original repo
git remote add upstream https://github.com/RedHatGov/redhatgov.github.io

# Never push to upstream repo
git remote set-url --push upstream no_push

3 Verify your remotes

To verify the new upstream repo you've specified for your fork, type git remote -v. You should see the URL for your fork as origin, and the URL for the original repo as upstream.

origin  [email protected]:your-username/redhatgov.github.io.git (fetch)
origin  [email protected]:your-username/redhatgov.github.io.git (push)
upstream        https://github.com/RedHatGov/redhatgov.github.io (fetch)
upstream        no_push (push)

4 Modify your docs

Get your local docs branch, up to date:

git fetch upstream
git checkout docs
git merge upstream/docs

Then build your local docs branch, make changes, etc.

5 Keep your docs in sync

git fetch upstream
git merge upstream/docs

6 Commit your docs

git commit

Likely you'll go back and edit, build, test, etc.

7 Push your docs

When ready to review (or just to establish an offsite backup of your work), push your branch to your fork on github.com:

git push

8 Submit a pull request

  1. Visit your fork at https://github.com/your-username/redhatgov.github.io.git
  2. Click the Compare & Pull Request button next to your docs branch.

At this point you're waiting on us. We may suggest some changes or improvements or alternatives. We'll do our best to review and at least comment within 3 business days (often much sooner).

If you have upstream write access, please refrain from using the GitHub UI for creating PRs, because GitHub will create the PR branch inside the main repo rather than inside your fork.