Automated code review - Revision history

Devdocsbot: Protected "Automated code review": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-06-14T03:29:21Z

Protected "Automated code review": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 03:29, 14 June 2022
(No difference)

Devdocsbot: Update migration status and path

2022-06-14T03:27:03Z

Update migration status and path

← Older revision		Revision as of 03:27, 14 June 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/general/development/tools/cibot}}
	Moodle issues submitted for review and inclusion into core are examined by our continuous integration (ci) system and checked against various automated tests. We use the automated checks to help improve the code quality in Moodle.		Moodle issues submitted for review and inclusion into core are examined by our continuous integration (ci) system and checked against various automated tests. We use the automated checks to help improve the code quality in Moodle.

Poltawski: /* The git commit summary limit is too small is a silly rule! */

2016-02-25T11:18:11Z

The git commit summary limit is too small is a silly rule!

← Older revision		Revision as of 11:18, 25 February 2016
Line 37:		Line 37:
	Please [https://tracker.moodle.org/secure/CreateIssueDetails!init.jspa?pid=10020&issuetype=1&components=12431&summary=Problem%20with%20CiBot%20results%20on%20MDL-XXXXX file an issue] in the MDLSITE project, Integration component.		Please [https://tracker.moodle.org/secure/CreateIssueDetails!init.jspa?pid=10020&issuetype=1&components=12431&summary=Problem%20with%20CiBot%20results%20on%20MDL-XXXXX file an issue] in the MDLSITE project, Integration component.

	== The git commit summary limit is too small ~~is a silly rule!~~ ==		== The git commit summary limit is too small ==
	When you overrun the length limit many git tools do not display commits well. See how [https://github.com/moodle/moodle/commits/ea6f5480818c31763f91a90a0cafb6a63ca18117 github truncates ea6f548081] - it ruins the message and makes it harder for you to communicate your change to other developers.		When you overrun the length limit many git tools do not display commits well. See how [https://github.com/moodle/moodle/commits/ea6f5480818c31763f91a90a0cafb6a63ca18117 github truncates ea6f548081] - it ruins the message and makes it harder for you to communicate your change to other developers.

Poltawski: /* The git commit summary limit is too small */

2016-02-25T10:10:27Z

The git commit summary limit is too small

← Older revision		Revision as of 10:10, 25 February 2016
Line 37:		Line 37:
	Please [https://tracker.moodle.org/secure/CreateIssueDetails!init.jspa?pid=10020&issuetype=1&components=12431&summary=Problem%20with%20CiBot%20results%20on%20MDL-XXXXX file an issue] in the MDLSITE project, Integration component.		Please [https://tracker.moodle.org/secure/CreateIssueDetails!init.jspa?pid=10020&issuetype=1&components=12431&summary=Problem%20with%20CiBot%20results%20on%20MDL-XXXXX file an issue] in the MDLSITE project, Integration component.

	== The git commit summary limit is too small ==		== The git commit summary limit is too small is a silly rule! ==
	When you overrun the length limit many git tools do not display commits well. See how [https://github.com/moodle/moodle/commits/ea6f5480818c31763f91a90a0cafb6a63ca18117 github truncates ea6f548081] - it ruins the message and makes it harder for you to communicate your change to other developers.		When you overrun the length limit many git tools do not display commits well. See how [https://github.com/moodle/moodle/commits/ea6f5480818c31763f91a90a0cafb6a63ca18117 github truncates ea6f548081] - it ruins the message and makes it harder for you to communicate your change to other developers.

Poltawski: /* How do I report bugs in the CiBot report? */

2016-02-25T10:10:03Z

How do I report bugs in the CiBot report?

← Older revision		Revision as of 10:10, 25 February 2016
Line 35:		Line 35:

	==How do I report bugs in the CiBot report?==		==How do I report bugs in the CiBot report?==
	Please [https://tracker.moodle.org/secure/CreateIssueDetails!init.jspa?pid=10020&issuetype=1&components=12431&summary=Problem%20with%20CiBot%20results%20on%20MDL-XXXXX file an issue] in the MDLSITE ~~component~~, Integration component.		Please [https://tracker.moodle.org/secure/CreateIssueDetails!init.jspa?pid=10020&issuetype=1&components=12431&summary=Problem%20with%20CiBot%20results%20on%20MDL-XXXXX file an issue] in the MDLSITE project, Integration component.

	== The git commit summary limit is too small ==		== The git commit summary limit is too small ==

Poltawski: /* Example situations */

2016-02-25T10:09:14Z

Example situations

← Older revision		Revision as of 10:09, 25 February 2016
Line 15:		Line 15:
	There are some conventions that are not uniformly followed in the code base, many of these are conventions put in place after code was written. Our long term goal is for the entire codebase to follow the conventions, but in general, we don't want large-scale reformatting of existing code. See [[Coding_style#Policy_about_coding-style_only_fixes]].		There are some conventions that are not uniformly followed in the code base, many of these are conventions put in place after code was written. Our long term goal is for the entire codebase to follow the conventions, but in general, we don't want large-scale reformatting of existing code. See [[Coding_style#Policy_about_coding-style_only_fixes]].

	==== Example situations====		==== Example "Should I fix coding style" situations====
	'''a) Spacing of if statements is incorrect on the line being changed'''		'''a) Spacing of if statements is incorrect on the line being changed'''

Poltawski: /* Should coding style issues in existing code be fixed? */

2016-02-25T10:08:55Z

Should coding style issues in existing code be fixed?

← Older revision		Revision as of 10:08, 25 February 2016
Line 15:		Line 15:
	There are some conventions that are not uniformly followed in the code base, many of these are conventions put in place after code was written. Our long term goal is for the entire codebase to follow the conventions, but in general, we don't want large-scale reformatting of existing code. See [[Coding_style#Policy_about_coding-style_only_fixes]].		There are some conventions that are not uniformly followed in the code base, many of these are conventions put in place after code was written. Our long term goal is for the entire codebase to follow the conventions, but in general, we don't want large-scale reformatting of existing code. See [[Coding_style#Policy_about_coding-style_only_fixes]].

	=== Example situations ===		==== Example situations====
	~~====~~ Spacing of if statements is incorrect on the line being changed ~~====~~		'''a) Spacing of if statements is incorrect on the line being changed'''

	This can be corrected without affecting existing code, so should be fixed.		This can be corrected without affecting existing code, so should be fixed.

	~~====~~ The line being changed contains an invalid variable name ~~====~~		'''b) The line being changed contains an invalid variable name'''

	If correcting this variable would affect other parts of the code not covered by the patch then it's not reasonable to fix it.		If correcting this variable would affect other parts of the code not covered by the patch then it's not reasonable to fix it.

Poltawski: Rearrange page a little (remove easily outdated info)

2016-02-25T10:04:09Z

Rearrange page a little (remove easily outdated info)

@@ Line 3: / Line 3: @@
 == What is CiBot? ==
 CiBot is our automated code checker and it will run checks against any issues waiting for peer review, sent for integration or requested to be checked by the developer. It will report problems discovered in lines of your patch which you are changing.
 == Will an issue be automatically rejected if cibot checks fail? ==
@@ Line 44: / Line 31: @@
 * The checks should be consistent and completely reproducible
 * The check should complete in minutes not hours (other solutions are in planning for longer term tests)
 == The git commit summary  limit is too small ==
@@ Line 74: / Line 64: @@
 </blockquote>
 ― Hal Abelson, Structure and Interpretation of Computer Programs
 ==See also==

Poltawski: Add note about reporting bugs in cibot result.

2016-02-25T10:02:39Z

Add note about reporting bugs in cibot result.

← Older revision		Revision as of 10:02, 25 February 2016
Line 74:		Line 74:
	</blockquote>		</blockquote>
	― Hal Abelson, Structure and Interpretation of Computer Programs		― Hal Abelson, Structure and Interpretation of Computer Programs

			==How do I report bugs in the CiBot report?==
			Please [https://tracker.moodle.org/secure/CreateIssueDetails!init.jspa?pid=10020&issuetype=1&components=12431&summary=Problem%20with%20CiBot%20results%20on%20MDL-XXXXX file an issue] in the MDLSITE component, Integration component.

	==See also==		==See also==

Scaroodle: Typo

2015-03-15T11:26:06Z

Typo

← Older revision		Revision as of 11:26, 15 March 2015
Line 33:		Line 33:

	==== The line being changed contains an invalid variable name ====		==== The line being changed contains an invalid variable name ====
	If correcting this variable would affect other parts of the code not covered by the patch then ~~its~~ not reasonable to fix it.		If correcting this variable would affect other parts of the code not covered by the patch then it's not reasonable to fix it.

	== Requesting CiBot checks an issue ==		== Requesting CiBot checks an issue ==