Actions

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

From Joomla! Documentation

m (Fill in any additional information in the pull request including a reference to the joomlacode issue.)
(Add branch info.)
 
(2 intermediate revisions by one user not shown)
Line 8: Line 8:
 
== Find the file you want to modify on Github==
 
== Find the file you want to modify on Github==
 
[[File:easygithub2.png|frame|none]]
 
[[File:easygithub2.png|frame|none]]
 +
 +
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 ==  
 
== Click Edit to open the file ==  
Line 18: Line 20:
 
  [[File:easygithub6.png|frame|none]]
 
  [[File:easygithub6.png|frame|none]]
  
== Fill in any additional information in the pull request including a reference to the joomlacode issue.==
+
== Fill in any additional information in the pull request including references to an existing issue or PR.==
 
  [[File:easygithub7.png|frame|none]]
 
  [[File:easygithub7.png|frame|none]]
  
'''NOTE: For pull requests for joomla-platform, the 'base branch' on the left must be set to staging (not master).
+
'''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.==
 
== Click Send pull request.==
 
[[File:easygithub8.png|frame|none]]
 
[[File:easygithub8.png|frame|none]]
 
== Make a note in the joomlacode issue with any a link to the pull request.==
 
[[File:easygithub9.png|frame|none]]
 
 
  
 
[[Category: Bug Squad]] [[Category: Development]]
 
[[Category: Bug Squad]] [[Category: Development]]
 +
[[Category:GitHub]]

Latest revision as of 18:15, 26 August 2014

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.

Contents

Identify a change you want to make.

Easygithub1.png

Find the file you want to modify on Github

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

Easygithub4.png

Make your change

Easygithub5.png

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

Easygithub6.png

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

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.

Easygithub8.png