-
Notifications
You must be signed in to change notification settings - Fork 100
create a pr
To contribute to Uyuni documentation:
-
Make sure you have a GitHub account, and that you’re signed in.
-
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. -
Wait for github to create your fork and redirect you.
-
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
-
Change into the directory that contains the repo, and check out the
/master
branch:cd uyuni-docs git checkout master
-
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. -
Add the uyuni-docs repo as an upstream:
git remote add upstream https://github.com/uyuni-project/uyuni-docs.git
-
Check:
git remote -v
This command should now have the same two
origin
remotes as before, plus two more labelledupstream
, 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)
-
Check out your fork’s
master
branch:git checkout master
-
Fetch the branches in the upstream repository:
git fetch upstream
-
Merge the changes from the upstream
master
branch, into your fork’smaster
branch:git merge upstream/master
-
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