almalinux/pungi
14
1
Fork 0
Code Issues Pull Requests Releases Activity

update docs now devel-4-pungi is merged to master, minor spelling fixes

Browse Source
This commit is contained in:
Peter Robinson 2015-06-07 00:28:28 +01:00
parent fd8cd62e79
commit ac24cfa1f9
1 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/contributing/README
View File

@ -1,9 +1,10 @@
############################################################################## ##############################################################################
# Developing # Developing
Currently the development workflow for pungi4 (devel-4-pungi) branch is: Currently the development workflow for pungi 4 is on master:
- Make your own fork at https://pagure.io/pungi
- Make your own for at https://pagure.io/pungi
- Clone your fork locally (replacing $USERNAME with your own): - Clone your fork locally (replacing $USERNAME with your own):
git clone git@pagure.io:forks/$USERNAME/pungi.git git clone git@pagure.io:forks/$USERNAME/pungi.git
@ -12,15 +13,15 @@ Currently the development workflow for pungi4 (devel-4-pungi) branch is:
git remote add upstream git@pagure.io:pungi.git git remote add upstream git@pagure.io:pungi.git
#NOTE: This workflow assumes that you never 'git commit' directly to #NOTE: This workflow assumes that you never 'git commit' directly to
# the devel-4-pungi branch of your fork. This will make more sense # the master branch of your fork. This will make more sense
# when we cover rebasing below. # when we cover rebasing below.
- create a topic branch based on devel-4-pungi - create a topic branch based on master
git branch my_topic_branch devel-4-pungi git branch my_topic_branch master
git checkout my_topic_branch git checkout my_topic_branch
- Make edits, changes, add new features, etc. and then make sure to pull - Make edits, changes, add new features, etc. and then make sure to pull
from upstream and rebase before submitting a pull request. from upstream master and rebase before submitting a pull request.
## lets just say you edited setup.py for sake of argument ## lets just say you edited setup.py for sake of argument
git checkout my_topic_branch git checkout my_topic_branch
# make changes to setup.py # make changes to setup.py
@ -28,19 +29,20 @@ Currently the development workflow for pungi4 (devel-4-pungi) branch is:
git commit -m "added awesome feature to setup.py" git commit -m "added awesome feature to setup.py"
## Now we rebase ## Now we rebase
git checkout devel-4-pungi git checkout master
git fetch upstream git fetch upstream
git fetch upstream --tags git fetch upstream --tags
git merge upstream/devel-4-pungi git merge upstream/master
git push origin devel-4-pungi git push origin master
git push origin --tags git push origin --tags
git checkout my_topic_branch git checkout my_topic_branch
git rebase devel-4-pungi git rebase master
# Resolve merge conflicts if any as a result of your development in # Resolve merge conflicts if any as a result of your development in
# your topic branch # your topic branch
git push origin my_topic_branch git push origin my_topic_branch
- Create pull request in the pagure.io web UI - Create pull request in the pagure.io web UI
- For convenience, here is a bash shell function that can be placed in your - For convenience, here is a bash shell function that can be placed in your
~/.bashrc and called such as 'pullupstream pungi-4-devel' that will ~/.bashrc and called such as 'pullupstream pungi-4-devel' that will
automate a large portion of the rebase steps from above. automate a large portion of the rebase steps from above.