Changes between Initial Version and Version 1 of Contribute

Timestamp:

May 28, 2010, 5:05:10 AM (15 years ago)

Author:

Garry Yao

Comment:

Init page

Contribute

@@ +1 @@
+
+[[PageOutline]]
+
+= How to contribute to (F)CKEditor =
+
+There are several ways you can help its development, here's the guidelines:
+
+ * By [#Reportingbugs reporting bugs].
+ * By [#Providingpatches submitting patches].
+ * By [#Translating translating]
+ * By [#Documentation writing] documentation.
+ * By writing [http://docs.cksource.com/FCKeditor_3.x/Design_and_Architecture/Plugin_Based plugins] around (F)CKEditor.
+ * By '''helping''' others through our [http://cksource.com/forums/viewforum.php?f=10 support board] on forum.
+ * By '''discussing''' on how (F)CKEditor could be improved by posting on the [http://cksource.com/forums/viewforum.php?f=11 development board] on forum.
+
+== Reporting bugs ==
+Described [wiki:Bugs here].
+== Providing patches ==
+
+We do love patches, but several rules must be followed to may them been efficiently accepted:
+
+=== Providing patches ===
+Inside a patch, following [wiki:CodingStyle coding standards] is one of the easiest way for everybody to understand everybody's code and require no housekeeping.
+
+Patch files are the official way to present us your contirubtion, it should always be in the [http://en.wikipedia.org/wiki/Diff unified diff] format and apply to the conventoin described [wiki:TicketLifeCycle#ProposingPatches here].
+
+Please don't put the patch in the ticket description or comment, unless it's a single line patch.
+
+The patch should dedicate to code required to fix a problem or add a feature, may include relevant test case(s) to verify the result, and that should be all of it, avoid trying to address other irrelevant problems in it.
+
+If the code associated with a patch adds a new feature, or modifies behavior of an existing feature, the patch should also contain documentation.
+
+To make sure the quality of project, we only open repository commit permission for core developers, as a community contributors, it's enough to add ''''HasPatch'''' to the '''keyword''' ticket field, and let the core developers take care of the integration it into the [wiki:TicketLifeCycle workflow].
+Depending on the review result, your patch may finally get accepted and get commited, or you may choose to come with a new patch in case the review fails.
+
+=== Translating ===
+
+Our language files are managed as other source files, you can find them in the [http://dev.fckeditor.net/browser/CKEditor/trunk/_source/lang lang] directory.
+
+=== Documentation ===
+
+Our documentation is composed in English, you're welcomed to write in the project's documentation site with an [http://docs.cksource.com/index.php?title=Special:UserLogin&type=signup&returnto=CKEditor_3.x/Developers_Guide account].