Maemo contribution guidelines

(→Quality)
(wikify section headings)
 
(15 intermediate revisions not shown)
Line 1: Line 1:
-
'''DRAFT'''
 
-
 
These are the guidelines third party developers need to observe when contributing code to open source software maintained or distributed by Nokia in the Maemo platform:
These are the guidelines third party developers need to observe when contributing code to open source software maintained or distributed by Nokia in the Maemo platform:
-
=== Contributions welcome! ===
+
== Contributions welcome! ==
 +
 
The Maemo SW team at Nokia encourages revision and feedback of the open source components of the Maemo platform and related open source applications.
The Maemo SW team at Nokia encourages revision and feedback of the open source components of the Maemo platform and related open source applications.
-
=== Sources ===
+
== Sources ==
 +
 
The sources of the Maemo platform and related Nokia developed open source applications are available at git.maemo.org. (planned)
The sources of the Maemo platform and related Nokia developed open source applications are available at git.maemo.org. (planned)
-
=== Releases ===
+
== Releases ==
-
The best timing for contributions is prior to the final version of a release. Alphas and betas are released for that purpose.
+
-
Early contributions on new releases are encouraged too, noting that UI changes might be difficult to be accepted because of design, localization, usability and end user testing implications.
+
Patches are most welcome in the ongoing alpha/beta release. Bugfixes on new stable releases are encouraged too.
-
=== Submissions ===
+
Note that it is very complex for maintainers to apply UI changes on final releases since they might originate new iterations in localization, usability and testing.
-
Bugfixes need to be referenced in existing or new bugs filed at http://bugs.maemo.org, including the keyword "Patch".  
+
 
 +
== Submissions ==
 +
 
 +
Bugfixes need to be referenced in existing or new bugs filed at https://bugs.maemo.org, including the keyword "[https://bugs.maemo.org/describekeywords.cgi#patch patch]".  
Developers can attach patches to the bug report or can host them in their own git directory at git.maemo.org (planned).
Developers can attach patches to the bug report or can host them in their own git directory at git.maemo.org (planned).
-
=== Upstream ===
+
== Upstream ==
-
Patches to software components developed upstream need to be submitted to their original projects.
+
-
It is recommended to notify in bugs.maemo.org the contribution to the related Maemo SW developers by providing URLs to the bug/patch submitted upstream. They might help pushing the patch and/or committing it to the Maemo related component.
+
Patches to software components developed upstream need to be submitted following the contribution guidelines of the original projects.
-
If the upstream is not Maemo SW but another team at Nokia (for instance Qt SW) then their contribution guidelines prevail.
+
If the upstream component has no Maemo specific versioning, it is better to contribute the patch directly upstream. Please notify the Maemo SW maintainers through https://bugs.maemo.org, they might get your patch anyway and help you getting it committed upstream.
-
=== Quality ===
+
== Quality ==
-
Software contributions need to take into account the Maemo [http://maemo.org/maemo_release_documentation/maemo4.1.x/node16.html quality considerations] and [http://maemo.org/maemo_release_documentation/maemo4.1.x/node16.html#SECTION001630000000000000000 coding style]. See how is a [[The Good Patch|good patch]].
+
-
=== License ===
+
Software contributions need to take into account the Maemo [http://maemo.org/maemo_release_documentation/maemo4.1.x/node16.html quality considerations] and [http://maemo.org/maemo_release_documentation/maemo4.1.x/node16.html#SECTION001630000000000000000 coding style].
-
The most sensible license chosen for the patches submitted is the license used by the component patched.
+
 
 +
Learn more about [[The Good Patch]].
 +
 
 +
== License ==
 +
 
 +
If you want your patch to be accepted you better use the same license used by the component patched.
 +
 
 +
== Copyright ==
-
=== Copyright ===
 
Developers of significant code contributions retain their copyrights and are credited.
Developers of significant code contributions retain their copyrights and are credited.
Ideas or contributions below 15 lines are usually not considered subject to copyrights. For details see the definition of [http://www.gnu.org/prep/maintain/maintain.html#Legally-Significant legally significant changes] made by the GNU Project.
Ideas or contributions below 15 lines are usually not considered subject to copyrights. For details see the definition of [http://www.gnu.org/prep/maintain/maintain.html#Legally-Significant legally significant changes] made by the GNU Project.
 +
 +
[[Category:Development]]
 +
[[Category:Community]]

Latest revision as of 13:58, 4 March 2011

These are the guidelines third party developers need to observe when contributing code to open source software maintained or distributed by Nokia in the Maemo platform:

Contents

[edit] Contributions welcome!

The Maemo SW team at Nokia encourages revision and feedback of the open source components of the Maemo platform and related open source applications.

[edit] Sources

The sources of the Maemo platform and related Nokia developed open source applications are available at git.maemo.org. (planned)

[edit] Releases

Patches are most welcome in the ongoing alpha/beta release. Bugfixes on new stable releases are encouraged too.

Note that it is very complex for maintainers to apply UI changes on final releases since they might originate new iterations in localization, usability and testing.

[edit] Submissions

Bugfixes need to be referenced in existing or new bugs filed at https://bugs.maemo.org, including the keyword "patch".

Developers can attach patches to the bug report or can host them in their own git directory at git.maemo.org (planned).

[edit] Upstream

Patches to software components developed upstream need to be submitted following the contribution guidelines of the original projects.

If the upstream component has no Maemo specific versioning, it is better to contribute the patch directly upstream. Please notify the Maemo SW maintainers through https://bugs.maemo.org, they might get your patch anyway and help you getting it committed upstream.

[edit] Quality

Software contributions need to take into account the Maemo quality considerations and coding style.

Learn more about The Good Patch.

[edit] License

If you want your patch to be accepted you better use the same license used by the component patched.

[edit] Copyright

Developers of significant code contributions retain their copyrights and are credited.

Ideas or contributions below 15 lines are usually not considered subject to copyrights. For details see the definition of legally significant changes made by the GNU Project.

Retrieved from "http://bugs.maemo.org/Maemo_contribution_guidelines"