Difference between revisions of "Using the Github UI to Make Pull Requests"

From Joomla! Documentation

m (Needs updating for the PR process on gitHub)
(13 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
Github has a simple web interface that makes it very easy to propose a simple change to code. You do not need to install any software or do anything beside register for a git hub account.
 
Github has a simple web interface that makes it very easy to propose a simple change to code. You do not need to install any software or do anything beside register for a git hub account.
  
===1 Identify a change you want to make.===
+
These suggestions apply to forks of both joomla-cms and joomla-platform, although the screenshots are for joomla-cms.
[[File:easygithub1.png]]
 
===2 Find the file you want to modify on Github===
 
[[File:easygithub2.png]]
 
===3 Click Edit to open the file===
 
[[File:easygithub4.png]]
 
  
===4 Make your change===
+
== Identify a change you want to make. ==
[[File:easygithub5.png]]
+
[[File:easygithub1.png|frame|none]]
===5 Scroll down and click the Propose file change button (add a note if you want).===
 
[[File:easygithub6.png]]
 
===6 Fill in any additional information in the pull request including a reference to the joomlacode issue.===
 
[[File:easygithub7.png]]
 
===7 Click Send pull request.===
 
[[File:easygithub8.png]]
 
===8 Make a note in the joomlacode issue with a link to the pull request.===
 
[[File:easygithub9.png]]
 
  
 +
== Find the file you want to modify on Github==
 +
[[File:easygithub2.png|frame|none]]
  
[[Category: Bug Squad]] [[Category: Development]]
+
Note if you want to make the change to 2.5 the branch should be 2.5.x, and if you want to make the change to 3.x then make the change to the staging branch. You should never PR to the master branch.
 +
 
 +
== Click Edit to open the file ==
 +
[[File:easygithub4.png|frame|none]]
 +
 
 +
== Make your change==
 +
[[File:easygithub5.png|frame|none]]
 +
 
 +
== Scroll down and click the Propose file change button (add a note if you want).==
 +
[[File:easygithub6.png|frame|none]]
 +
 
 +
== Fill in any additional information in the pull request including references to an existing issue or PR.==
 +
[[File:easygithub7.png|frame|none]]
 +
 
 +
'''NOTE: For pull requests for joomla-cms, the 'base branch' on the left must be set to staging (not master).
 +
'''
 +
 
 +
'''NOTE: Joomla Code has now been deprecated. You do NOT need a JoomlaCode link in your pull request anymore.
 +
'''
 +
 
 +
== Click Send pull request.==
 +
[[File:easygithub8.png|frame|none]]
 +
 
 +
<noinclude>
 +
[[Category:Bug Squad]]
 +
[[Category:Development]]
 +
[[Category:GitHub]]
 +
[[Category:Needs updating]]
 +
</noinclude>

Revision as of 13:08, 16 May 2015

Github has a simple web interface that makes it very easy to propose a simple change to code. You do not need to install any software or do anything beside register for a git hub account.

These suggestions apply to forks of both joomla-cms and joomla-platform, although the screenshots are for joomla-cms.

Identify a change you want to make.[edit]

Easygithub1.png

Find the file you want to modify on Github[edit]

Easygithub2.png

Note if you want to make the change to 2.5 the branch should be 2.5.x, and if you want to make the change to 3.x then make the change to the staging branch. You should never PR to the master branch.

Click Edit to open the file[edit]

Easygithub4.png

Make your change[edit]

Easygithub5.png

Scroll down and click the Propose file change button (add a note if you want).[edit]

Easygithub6.png

Fill in any additional information in the pull request including references to an existing issue or PR.[edit]

Easygithub7.png

NOTE: For pull requests for joomla-cms, the 'base branch' on the left must be set to staging (not master).

NOTE: Joomla Code has now been deprecated. You do NOT need a JoomlaCode link in your pull request anymore.

Click Send pull request.[edit]

Easygithub8.png