Changes between Initial Version and Version 1 of Contribute

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

Init page


  • Contribute

    v1 v1  
     4= How to contribute to (F)CKEditor =
     6There are several ways you can help its development, here's the guidelines:
     8 * By [#Reportingbugs reporting bugs].
     9 * By [#Providingpatches submitting patches].
     10 * By [#Translating translating]
     11 * By [#Documentation writing] documentation.
     12 * By writing [ plugins] around (F)CKEditor.
     13 * By '''helping''' others through our [ support board] on forum.
     14 * By '''discussing''' on how (F)CKEditor could be improved by posting on the [ development board] on forum.
     16== Reporting bugs ==
     17Described [wiki:Bugs here].
     18== Providing patches ==
     20We do love patches, but several rules must be followed to may them been efficiently accepted:
     22=== Providing patches ===
     23Inside a patch, following [wiki:CodingStyle coding standards] is one of the easiest way for everybody to understand everybody's code and require no housekeeping.
     25Patch files are the official way to present us your contirubtion, it should always be in the [ unified diff] format and apply to the conventoin described [wiki:TicketLifeCycle#ProposingPatches here].
     27Please don't put the patch in the ticket description or comment, unless it's a single line patch.
     29The 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.
     31If the code associated with a patch adds a new feature, or modifies behavior of an existing feature, the patch should also contain documentation.
     33To 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].
     34Depending 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.
     36=== Translating ===
     38Our language files are managed as other source files, you can find them in the [ lang] directory.
     40=== Documentation ===
     42Our documentation is composed in English, you're welcomed to write in the project's documentation site with an [ account]. 
© 2003 – 2019 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy