Skip to content

create a pr

Joseph Cayouette edited this page Apr 5, 2023 · 1 revision

First Contribution

To contribute to Uyuni documentation:

Procedure: Contributing Using a Fork
  1. Make sure you have a GitHub account, and that you’re signed in.

  2. Navigate to the [Uyuni Documentation Repo](https://github.com/uyuni-project/uyuni-docs.git), click the Fork button in the top-right corner, and select the account you want to use.

  3. Wait for github to create your fork and redirect you.

  4. Clone the repository to your local machine. To find this URL, click the green Code button and copy the HTTPS URL:

    git clone https://github.com/<username>/uyuni-docs.git
  5. Change into the directory that contains the repo, and check out the /master branch:

    cd uyuni-docs
    git checkout master
  6. List the current remote branches:

    git remote -v

    This command should list two remotes, both marked origin, like this:

    origin  https://github.com/<username>/uyuni-docs.git (fetch)
    origin  https://github.com/<username>/uyuni-docs.git (push)

    The origin remotes are your own fork, and you can do whatever you want here without changing the upstream repository.

  7. Add the uyuni-docs repo as an upstream:

    git remote add upstream https://github.com/uyuni-project/uyuni-docs.git
  8. Check:

    git remote -v

    This command should now have the same two origin remotes as before, plus two more labelled upstream, like this:

    origin  https://github.com/<username>/uyuni-docs.git (fetch)
    origin  https://github.com/<username>/uyuni-docs.git (push)
    upstream  https://github.com/uyuni-project/uyuni-docs.git (fetch)
    upstream  https://github.com/uyuni-project/uyuni-docs.git (push)
  9. Check out your fork’s master branch:

    git checkout master
  10. Fetch the branches in the upstream repository:

    git fetch upstream
  11. Merge the changes from the upstream master branch, into your fork’s master branch:

    git merge upstream/master
  12. Create a new branch for the work you want to do. Make sure you give it an appropriate name, and include your username:

    git checkout -b update-readme-username
Clone this wiki locally