Contributing to Core - Revision history

Diego.ruiz at 16:21, 28 October 2022

2022-10-28T16:21:01Z

CarlosRuiz: CarlosRuiz moved page Contributing to Trunk to Contributing to Core

2022-09-13T12:02:42Z

CarlosRuiz moved page Contributing to Trunk to Contributing to Core

Diego.ruiz at 10:37, 29 August 2022

2022-08-29T10:37:39Z

Diego.ruiz at 16:05, 20 December 2019

2019-12-20T16:05:13Z

Diego.ruiz: Minor fixes

2019-11-18T16:48:13Z

Minor fixes

Hieplq at 09:06, 1 September 2017

2017-09-01T09:06:03Z

Ralexsander: /* How to Contribute */

2016-12-15T20:17:04Z

How to Contribute

Diego.ruiz at 14:36, 16 February 2016

2016-02-16T14:36:15Z

Thomas Thießen: Add category

2015-09-19T11:52:07Z

Add category

Diego.ruiz: /* How to Contribute */

2015-09-09T10:34:43Z

How to Contribute

@@ Line 3: / Line 3: @@
 [[Category:Plug-In Development]]
 [[Category:Updated2022]]
 This tutorial is brought to you by [[User:Diego.ruiz|Diego Ruiz]] and [[User:TBayen|Thomas Bayen]] from BXService GmbH. If you have questions or improvement suggestions, feel free to write me [mailto:druiz@bayen.de an email]

@@ Line 2: / Line 2: @@
 [[Category:Developer documentation‏‎]]
 [[Category:Plug-In Development]]
 This tutorial is brought to you by [[User:Diego.ruiz|Diego Ruiz]] and [[User:TBayen|Thomas Bayen]] from BXService GmbH. If you have questions or improvement suggestions, feel free to write me [mailto:druiz@bayen.de an email]

← Older revision		Revision as of 16:05, 20 December 2019
Line 4:		Line 4:

	This tutorial is brought to you by [[User:Diego.ruiz\|Diego Ruiz]] and [[User:TBayen\|Thomas Bayen]] from BXService GmbH. If you have questions or improvement suggestions, feel free to write me [mailto:druiz@bayen.de an email]		This tutorial is brought to you by [[User:Diego.ruiz\|Diego Ruiz]] and [[User:TBayen\|Thomas Bayen]] from BXService GmbH. If you have questions or improvement suggestions, feel free to write me [mailto:druiz@bayen.de an email]
		+
		+	This is part of a list of all possible contributions, you can check those in [[Contributing to iDempiere]].

	=The goal of this tutorial=		=The goal of this tutorial=

@@ Line 16: / Line 16: @@
 *Check the backward compatibility. If you find "unused" fields, assume that they can be used by people in different ways in many implementations.
 *Comments, methods and variables '''MUST''' be in English.
-**Always think in the community peer reviewers - it's always better to comment code that is not easy to understand - but excess of need for comments can mean that names or algorithms can be improved
+**Always think in the community peer reviewers - it's always better to comment code that is not easy to understand - but an excess of need for comments can mean that names or algorithms can be improved
 *Big things or big changes require big documentation (manual, use cases, test cases)
 *Mixing new features code and re-factoring code is hard to review. Please make different commits for both cases.
 *When possible avoid the SQL Code, use the data model instead.
-If people think only about satisfying their own needs without caring about the community welfare, the code becomes untenable and to evolve it becomes more difficult or even impossible at some point.
+If people think only about satisfying their own needs without caring about community welfare, the code becomes untenable and to evolve it becomes more difficult or even impossible at some point.
-So with that in mind we decided to create this checklist to make it easier for everyone to contribute great code, be a part of this community and become known for continuous help and contributions.
+So with that in mind, we decided to create this checklist to make it easier for everyone to contribute great code, be a part of this community and become known for continuous help and contributions.
 =How to Contribute=
@@ Line 36: / Line 36: @@
 **Query Class.
 **DB Class (DB.get())
-**And finally jdbc, only if it is really needed as the impact in the memory is greater than the approaches above.
+**And finally JDBC, only if it is really needed as the impact in the memory is greater than the approaches above.
 *Java classes, methods and variable formats. Follow the java standards (meaningful names, camel case). The code should be indented to improve its readability and maintainability.
 *Make sure each java class has the GPLv2 Header.
@@ Line 48: / Line 48: @@
 **First you need to [http://wiki.idempiere.org/en/Centralized_ID_Management Manage the Centralized IDs ]
 **Then [http://wiki.idempiere.org/en/Generating_Migration_Scripts Generate the Migration Scripts]
-**When generating migration script is good practice to set the comment in DICTIONARY_ID_COMMENTS sysconfig key. The migration script will receive it, but also will help to let know other developers what's the reservation about when receiving the email
+**When generating a migration script is a good practice to set the right value for the DICTIONARY_ID_COMMENTS SysConfig key. The migration script will take it, while also helping other developers to know what is being worked on when they receive the email of an official ID assignment.
 *When you have successfully created your migration scripts name them with this format: '''yyyymmddhhmm_ticket.sql'''
 *Add at the end of both migration scripts the register line e.g: ''SELECT register_migration_script('201504180139_IDEMPIERE-2556.sql') FROM dual''
-*Copy the respective scripts into the postgresql folder and the oracle folder (migration/i2.1z/...)
+*Copy the respective scripts into the PostgreSQL folder and the oracle folder (migration/i2.1z/...)
 ==Changing the code==
-*When add, remove or change signature a public function. It's advised to regenerate serialVersionUID
+*When adding, removing or changing the signature of a public method. It's advised to regenerate the serialVersionUID.
-*When change signature of public function, better do a overload.
+*When changing the signature of a public method, better do an overload.
-it help other customize code or plugin can working.
+it helps others customize code or plugin can working.
 [[Category:HowTo-Technical]]
 [[Category:Development‏‎]]

@@ Line 48: / Line 48: @@
 **First you need to [http://wiki.idempiere.org/en/Centralized_ID_Management Manage the Centralized IDs ]
 **Then [http://wiki.idempiere.org/en/Generating_Migration_Scripts Generate the Migration Scripts]
 *When you have successfully created your migration scripts name them with this format: '''yyyymmddhhmm_ticket.sql'''
 *Add at the end of both migration scripts the register line e.g: ''SELECT register_migration_script('201504180139_IDEMPIERE-2556.sql') FROM dual''
 *Copy the respective scripts into the postgresql folder and the oracle folder (migration/i2.1z/...)
 [[Category:HowTo-Technical]]
 [[Category:Development‏‎]]

@@ Line 27: / Line 27: @@
 =How to Contribute=
-This a checklist of the main/minimum things that should be done to contribute in the core:
+This is a checklist of the main/minimum things that should be done to contribute in the core:
 *If you need to change the database check the [http://wiki.idempiere.org/en/Contributing_to_Trunk#Changing_the_database Changing the database] chapter first.
 ''Note: If your development needs the database changes and you don't do this first. You will have to do it all over again''

← Older revision		Revision as of 14:36, 16 February 2016
Line 51:		Line 51:
	*Add at the end of both migration scripts the register line e.g: ''SELECT register_migration_script('201504180139_IDEMPIERE-2556.sql') FROM dual''		*Add at the end of both migration scripts the register line e.g: ''SELECT register_migration_script('201504180139_IDEMPIERE-2556.sql') FROM dual''
	*Copy the respective scripts into the postgresql folder and the oracle folder (migration/i2.1z/...)		*Copy the respective scripts into the postgresql folder and the oracle folder (migration/i2.1z/...)
		+
		+
		+	[[Category:HowTo-Technical]]
		+	[[Category:Development‏‎]]

← Older revision		Revision as of 11:52, 19 September 2015
Line 1:		Line 1:
		+	[[Category:Development\|P]]
		+	[[Category:Developer documentation‏‎]]
		+	[[Category:Plug-In Development]]

	This tutorial is brought to you by [[User:Diego.ruiz\|Diego Ruiz]] and [[User:TBayen\|Thomas Bayen]] from BXService GmbH. If you have questions or improvement suggestions, feel free to write me [mailto:druiz@bayen.de an email]		This tutorial is brought to you by [[User:Diego.ruiz\|Diego Ruiz]] and [[User:TBayen\|Thomas Bayen]] from BXService GmbH. If you have questions or improvement suggestions, feel free to write me [mailto:druiz@bayen.de an email]

@@ Line 30: / Line 30: @@
 *Every commit must be related to a Jira ticket. Please do not mix commits, if the new code needed a refactoring of old code, create one patch for refactoring and one for the actual solution (This makes it easier for review).
 *When you want to get data. The best way to do it is in the following order:
-**Model Classes. Most of the M classes in iDempiere have a get method to avoid the reading from the database.
+**Model Classes. Most of the M classes in iDempiere have a get method to avoid reading from the database.
 **Query Class.
 **DB Class (DB.get())
-**And finally jdbc, only if its really needed as the impact in the memory is greater than the approaches above.
+**And finally jdbc, only if it is really needed as the impact in the memory is greater than the approaches above.
 *Java classes, methods and variable formats. Follow the java standards (meaningful names, camel case). The code should be indented to improve its readability and maintainability.
 *Make sure each java class has the GPLv2 Header.