Using the Github UI to Make Pull Requests - Revision history

Franz.wohlkoenig: Marked this version for translation

2021-09-21T16:12:36Z

Marked this version for translation

← Older revision		Revision as of 16:12, 21 September 2021
Line 5:		Line 5:
	This article helps you understanding and creating Pull Requests on Github, so you can contribute to a project like Joomla!. Many changes, including bug fixes and feature additions can be implemented and reviewed via the normal GitHub pull request workflow.		This article helps you understanding and creating Pull Requests on Github, so you can contribute to a project like Joomla!. Many changes, including bug fixes and feature additions can be implemented and reviewed via the normal GitHub pull request workflow.

			<!--T:33-->
	Some changes though are "substantial", and we ask that these be put through a bit of a design process and produce a consensus among the community and the core team.		Some changes though are "substantial", and we ask that these be put through a bit of a design process and produce a consensus among the community and the core team.
	</translate>		</translate>
Line 15:		Line 16:
	A hastily proposed pull request can hurt its chances of acceptance. Low quality proposals, proposals for previously rejected features, may be quickly rejected, which can be demotivating for the unprepared contributor. Laying some groundwork ahead of the pull request can make the process smoother.		A hastily proposed pull request can hurt its chances of acceptance. Low quality proposals, proposals for previously rejected features, may be quickly rejected, which can be demotivating for the unprepared contributor. Laying some groundwork ahead of the pull request can make the process smoother.

			<!--T:34-->
	Although there is no single way to prepare for submitting a pull request, it is generally a good idea to pursue feedback from other project developers beforehand to ascertain that the pull request may be desirable. Although it may seem like a useful feature or bug fix, there may be reasons it cannot work that you have not considered (or could not know about).		Although there is no single way to prepare for submitting a pull request, it is generally a good idea to pursue feedback from other project developers beforehand to ascertain that the pull request may be desirable. Although it may seem like a useful feature or bug fix, there may be reasons it cannot work that you have not considered (or could not know about).

			<!--T:35-->
	As a rule of thumb, receiving encouraging feedback from long-standing project developers, and particularly members of the core team or existing contributors, is a good indication that the pull request is worth pursuing. To get feedback, we suggest you join the [https://volunteers.joomla.org/ Volunteers Portal] and join RingCentral (still referred to as Glip, just ask a team lead in the Volunteers portal to add you) to ask other developers. Once you are ready, we suggest, before doing any code, you submit an issue to the [https://issues.joomla.org Joomla! issue tracker] with "RFC" at the beginning. That will create a request for comments which will help you to identify any additional work or issues you may have to overcome to get your idea accepted.		As a rule of thumb, receiving encouraging feedback from long-standing project developers, and particularly members of the core team or existing contributors, is a good indication that the pull request is worth pursuing. To get feedback, we suggest you join the [https://volunteers.joomla.org/ Volunteers Portal] and join RingCentral (still referred to as Glip, just ask a team lead in the Volunteers portal to add you) to ask other developers. Once you are ready, we suggest, before doing any code, you submit an issue to the [https://issues.joomla.org Joomla! issue tracker] with "RFC" at the beginning. That will create a request for comments which will help you to identify any additional work or issues you may have to overcome to get your idea accepted.
	</translate>		</translate>

Franz.wohlkoenig at 16:11, 21 September 2021

2021-09-21T16:11:45Z

← Older revision		Revision as of 16:11, 21 September 2021
Line 3:		Line 3:
	Tutorial</translate>}}		Tutorial</translate>}}
	<translate><!--T:2-->		<translate><!--T:2-->
	This article helps you understanding and creating Pull Requests on Github, so you can contribute to a project like Joomla!.		This article helps you understanding and creating Pull Requests on Github, so you can contribute to a project like Joomla!. Many changes, including bug fixes and feature additions can be implemented and reviewed via the normal GitHub pull request workflow.
	Many changes, including bug fixes and feature additions can be implemented and reviewed via the normal GitHub pull request workflow.

	~~<!--T:27-->~~
	Some changes though are "substantial", and we ask that these be put through a bit of a design process and produce a consensus among the community and the core team.		Some changes though are "substantial", and we ask that these be put through a bit of a design process and produce a consensus among the community and the core team.
	</translate>		</translate>
Line 17:		Line 15:
	A hastily proposed pull request can hurt its chances of acceptance. Low quality proposals, proposals for previously rejected features, may be quickly rejected, which can be demotivating for the unprepared contributor. Laying some groundwork ahead of the pull request can make the process smoother.		A hastily proposed pull request can hurt its chances of acceptance. Low quality proposals, proposals for previously rejected features, may be quickly rejected, which can be demotivating for the unprepared contributor. Laying some groundwork ahead of the pull request can make the process smoother.

	~~<!--T:30-->~~
	Although there is no single way to prepare for submitting a pull request, it is generally a good idea to pursue feedback from other project developers beforehand to ascertain that the pull request may be desirable. Although it may seem like a useful feature or bug fix, there may be reasons it cannot work that you have not considered (or could not know about).		Although there is no single way to prepare for submitting a pull request, it is generally a good idea to pursue feedback from other project developers beforehand to ascertain that the pull request may be desirable. Although it may seem like a useful feature or bug fix, there may be reasons it cannot work that you have not considered (or could not know about).

	~~<!--T:31-->~~
	As a rule of thumb, receiving encouraging feedback from long-standing project developers, and particularly members of the core team or existing contributors, is a good indication that the pull request is worth pursuing. To get feedback, we suggest you join the [https://volunteers.joomla.org/ Volunteers Portal] and join RingCentral (still referred to as Glip, just ask a team lead in the Volunteers portal to add you) to ask other developers. Once you are ready, we suggest, before doing any code, you submit an issue to the [https://issues.joomla.org Joomla! issue tracker] with "RFC" at the beginning. That will create a request for comments which will help you to identify any additional work or issues you may have to overcome to get your idea accepted.		As a rule of thumb, receiving encouraging feedback from long-standing project developers, and particularly members of the core team or existing contributors, is a good indication that the pull request is worth pursuing. To get feedback, we suggest you join the [https://volunteers.joomla.org/ Volunteers Portal] and join RingCentral (still referred to as Glip, just ask a team lead in the Volunteers portal to add you) to ask other developers. Once you are ready, we suggest, before doing any code, you submit an issue to the [https://issues.joomla.org Joomla! issue tracker] with "RFC" at the beginning. That will create a request for comments which will help you to identify any additional work or issues you may have to overcome to get your idea accepted.
	</translate>		</translate>

	<translate>		<translate>

	== What is a Pull Request? == <!--T:3-->		== What is a Pull Request? == <!--T:3-->
	</translate>		</translate>
	<translate><!--T:4-->		<translate><!--T:4-->
	A Pull Request is a ~~<b>~~request~~</b>~~ to ~~<b>~~pull~~</b>~~ some code to a repository (project) on GitHub.</translate>		A Pull Request is a '''request''' to '''pull''' some code to a repository (project) on GitHub.</translate>

	<translate><!--T:5-->		<translate><!--T:5-->
Line 37:		Line 32:

	<translate>		<translate>

	== Identify the change you would like to made == <!--T:7-->		== Identify the change you would like to made == <!--T:7-->
	</translate>		</translate>
Line 48:		Line 42:
	[[File:Before-patch.jpg\|The situation before the patch is applied]]		[[File:Before-patch.jpg\|The situation before the patch is applied]]
	<translate>		<translate>

	== Find the file you want to modify on Github== <!--T:10-->		== Find the file you want to modify on Github== <!--T:10-->
	</translate>		</translate>
Line 69:		Line 62:

	<translate>		<translate>

	== Make your changes == <!--T:13-->		== Make your changes == <!--T:13-->
	</translate>		</translate>
Line 91:		Line 83:

	<translate>		<translate>

	== Add a title and description == <!--T:17-->		== Add a title and description == <!--T:17-->
	</translate>		</translate>
Line 117:		Line 108:

	<translate>		<translate>

	== And now? == <!--T:22-->		== And now? == <!--T:22-->
	</translate>		</translate>

Flyingwombats at 15:31, 23 May 2020

2020-05-23T15:31:30Z

← Older revision		Revision as of 15:31, 23 May 2020
Line 95:		Line 95:
	</translate>		</translate>
	<translate><!--T:18-->		<translate><!--T:18-->
	Below the editor, we can ~~specify~~ our Pull Request ~~by adding~~ a title and a description.</translate>		Below in the editor, we can give our Pull Request a title and a description.</translate>

	<translate><!--T:19-->		<translate><!--T:19-->
	The title has to be short, and must ~~tell~~ what this pull request does.		The title has to be short and must explain what this pull request does.

	<!--T:26-->		<!--T:26-->

Flyingwombats at 15:30, 23 May 2020

2020-05-23T15:30:04Z

← Older revision		Revision as of 15:30, 23 May 2020
Line 104:		Line 104:
	</translate>		</translate>

	~~[[Image:Github_description.png]]~~

			[[File:Describe-changes.jpg\|Describe the changes]]
	<translate>		<translate>

Flyingwombats at 15:27, 23 May 2020

2020-05-23T15:27:05Z

← Older revision		Revision as of 15:27, 23 May 2020
Line 78:		Line 78:
	In our example, four files were edited so that the alias could be styled to go onto the next line. Origionally with a line brake but in discussion it was changed to a div</translate>		In our example, four files were edited so that the alias could be styled to go onto the next line. Origionally with a line brake but in discussion it was changed to a div</translate>
	<source lang="xml">		<source lang="xml">
	<~~span~~ class="~~icon-user~~"></~~span~~>		<div class=
			</source>
			and a closing
			<source lang="xml">
			</div>
	</source>		</source>

Flyingwombats at 15:24, 23 May 2020

2020-05-23T15:24:01Z

← Older revision		Revision as of 15:24, 23 May 2020
Line 66:		Line 66:
	</translate>		</translate>

	[[File:The files ~~changed~~.png\|The files ~~that were~~ changed]]		[[File:The files changed2.png\|The files changed]]

	<translate>		<translate>

Flyingwombats at 15:20, 23 May 2020

2020-05-23T15:20:59Z

← Older revision		Revision as of 15:20, 23 May 2020
Line 73:		Line 73:
	</translate>		</translate>
	<translate><!--T:14-->		<translate><!--T:14-->
	Navigate to the ~~file~~, and edit the ~~file~~ by clicking on the pencil icon on the right.</translate>		Navigate to the files, and edit the files by clicking on the pencil icon on the right.</translate>

	<translate><!--T:15-->		<translate><!--T:15-->
	In our example, ~~we add~~ the ~~following code~~ to line ~~14 of the file: <tt>autor~~.~~php</tt>~~</translate>		In our example, four files were edited so that the alias could be styled to go onto the next line. Origionally with a line brake but in discussion it was changed to a div</translate>
	<source lang="xml">		<source lang="xml">
	<span class="icon-user"></span>		<span class="icon-user"></span>

Flyingwombats at 15:11, 23 May 2020

2020-05-23T15:11:36Z

← Older revision		Revision as of 15:11, 23 May 2020
Line 57:		Line 57:
	<!--T:32-->		<!--T:32-->
	Before you start navigating through the files check that you are in the right <code>branch</code> There is a dropdown box to the left next to the 'New pull request' button. It will show staging which is the current branch of the CMS being worked on <code>Staging</code>. For the development of the next 3.10 version. <code>3.10-dev</code> and <code>4.0-dev</code>. Branch names can change! Ask fellow Joomla developers if you are not sure which branch to select.</translate>		Before you start navigating through the files check that you are in the right <code>branch</code> There is a dropdown box to the left next to the 'New pull request' button. It will show staging which is the current branch of the CMS being worked on <code>Staging</code>. For the development of the next 3.10 version. <code>3.10-dev</code> and <code>4.0-dev</code>. Branch names can change! Ask fellow Joomla developers if you are not sure which branch to select.</translate>
			[[File:Files-on-github.jpg\|An example of the files in the Joomla GitHub repository]]
	<translate><!--T:12-->		<translate><!--T:12-->
	Find the files you need to change. In our example, we have to edit the following files:		Find the files you need to change. In our example, we have to edit the following files:
Line 66:		Line 66:
	</translate>		</translate>

	[[File:~~Files-on-github~~.~~jpg~~\|~~An example of the~~ files ~~in the Joomla GitHub repository~~]]		[[File:The files changed.png\|The files that were changed]]

	<translate>		<translate>

Flyingwombats at 15:07, 23 May 2020

2020-05-23T15:07:40Z

← Older revision		Revision as of 15:07, 23 May 2020
Line 60:		Line 60:
	<translate><!--T:12-->		<translate><!--T:12-->
	Find the files you need to change. In our example, we have to edit the following files:		Find the files you need to change. In our example, we have to edit the following files:
	administrator/components/com_categories/tmpl/categories/default.php		* administrator/components/com_categories/tmpl/categories/default.php
	administrator/components/com_categories/tmpl/categories/modal.php		* administrator/components/com_categories/tmpl/categories/modal.php
	administrator/components/com_content/tmpl/articles/default.php		* administrator/components/com_content/tmpl/articles/default.php
	administrator/components/com_content/tmpl/featured/default.php		* administrator/components/com_content/tmpl/featured/default.php
	</translate>		</translate>

Flyingwombats at 15:06, 23 May 2020

2020-05-23T15:06:30Z

← Older revision		Revision as of 15:06, 23 May 2020
Line 59:		Line 59:

	<translate><!--T:12-->		<translate><!--T:12-->
	Find the files you need to change. In our example, we have to edit the following files: /~~layouts~~/~~joomla~~/~~content~~/~~info_block~~/~~author~~.php.</translate>		Find the files you need to change. In our example, we have to edit the following files:
			administrator/components/com_categories/tmpl/categories/default.php
			administrator/components/com_categories/tmpl/categories/modal.php
			administrator/components/com_content/tmpl/articles/default.php
			administrator/components/com_content/tmpl/featured/default.php
			</translate>

	[[File:Files-on-github.jpg\|An example of the files in the Joomla GitHub repository]]		[[File:Files-on-github.jpg\|An example of the files in the Joomla GitHub repository]]