Updating the repository - RedHatInsights/red-hat-ansible-automation-platform-documentation GitHub Wiki
To submit an update:
-
Fetch the latest changes from the upstream repository.
$ git fetch upstream
-
Check out a new branch from
upstream/main
.$ git checkout -b <new_branch> upstream/main
The
upstream/main
branch is the upstream parent branch of new_branch. -
Make your edits.
-
To test your changes, build the titles affected by the changes you made. View the built files in a browser.
-
View the current status of your local repository.
$ git status
-
Stage the changes for the files that you want to add to a commit.
$ git add <file_name>
-
Commit the changes, including a short message summarizing your changes.
$ git commit -m "<descriptive_commit_message>"
It’s useful to include the Jira issue number at the start of the message: when you view the commit history, it is clear which commits relate to your current work. The following example also mentions the title affected by the changes.
$ git commit -m "AAP-516 Add external database assembly to Operator Install guide"
For guidelines on commit message style, see this article.
-
Push the changes to your forked repository on GitHub. This backs up your local changes.
$ git push origin HEAD
-
Create a pull request. A pull request proposes that the changes you made to a branch in your fork be merged into a branch in the upstream repository. See Creating a pull request.