Pull Requests

Workflow

The sources for Fedora’s documentation are stored in git repositories at https://pagure.io. Contributions are accepted via pull requests, which merge changes from your copy of the repository into the original.

  • Install the required tools.

  • Log into pagure and click the Fork button at the upper right hand corner of a repository. You now have a personal copy of the repo, called a fork.

  • Clone your repository using the SSH URL.

git clone ssh://git@pagure.io/forks/immanetize/documentation-guide.git
cd documentation-guide
  • Create a branch to contian your work. This makes it easier for others to pull from your repo without disrupting their existing content. You can name the branch anything, but something that correlates to the work you’ll be doing is best.

git checkout -b pull_request_workflow
  • Make your changes using the editor of your choice. Add a commit for each distinct change.

git add en-US/pull_requests.adoc
git commit -m 'begin describing pull request workflow'
  • Push your changes to pagure.

git push
  • The new branch will now appear in your fork on pagure. Once you have pushed a cohesive set of changes, press the New PR button to start a new pull request. pagure will send your changes for review after you fill out the form and press Create.

  • Work with your reviewer to address any concerns. Subsequent commits pushed to this branch of your fork will be automatically included in the pull request.

  • Your changes get merged by the reviewer. Congratulations! Reward yourself with a beer, you’ve earned it!