Changes between Version 3 and Version 4 of Contribute

05/15/14 21:47:29 (3 years ago)



  • Contribute

    v3 v4  
    2 [[PageOutline]]
    42= How to Contribute to the CKEditor Project =
    5 There are several ways you can help CKEditor to become better software for yourself and to others. You can do that by:
    7  * [#Reportingbugs Reporting bugs]
    8  * [#Providingpatches Submitting patches]
    9  * [#Translating Translating]
    10  * [#Documentation Writing] documentation
    11  * Creating CKEditor [ plugins]
    12  * '''Helping''' others through our [ support board] on the community forum
    13  * '''Discussing''' how CKEditor could be improved by posting on the [ development board] of the community forum.
     4Articles moved to:
    15 == Reporting bugs ==
    16 Described [wiki:Bugs here].
    18 == Providing patches ==
    19 We love patches, but several rules must be followed in order for them to be accepted:
    21 Following CKEditor [wiki:CodingStyle coding standards] is the easiest way for everybody to understand your code and get it accepted without changes and unnecessary delay.
    23 Patch files are the official way to present your contribution. All patches should always be in the [ unified diff] format and stick to the conventions described [wiki:TicketLifeCycle#ProposingPatches here].
    25 Do not put the patch in the ticket description or comment unless it is a single line patch. Otherwise it is always better to attach a separate patch file.
    27 Each patch should contain the code required to fix a problem or add a new feature, and may include relevant test case(s) to verify the result. Try to avoid addressing other irrelevant problems in it.
    29 If the code associated with a patch adds a new feature, or modifies the behavior of an existing feature, the patch should also contain documentation.
    31 To ensure the high quality of the project code base we only grant repository commit permissions to core developers. For community contributors  it is enough to add ''''HasPatch'''' to the '''keyword''' ticket field, and let the core developers take care of integrating the patch into the [wiki:TicketLifeCycle workflow].
    32 Depending on the review result your patch may finally get accepted and get committed, or you may choose to come with a new patch in case the review fails.
    34 == Translating ==
    35 CKEditor interface can be fully localized. Our language files are managed just like all other source files and you can find them in the [ lang] directory of the CKEditor installation package. If you would like to supplement or improve any of the language files as well as create a new localization, create a ticket and attach a patch with your changes.
    37 == Documentation ==
    38 Our documentation is composed in English. You are welcome to add your comments to the '''Talk''' pages at the official documentation site with an [ account]. If you would like to contribute some additional documentation resources (tutorials, use cases, code documentation), please contact us first.
     6* [!/guide/dev_contributing Contributing to CKEditor]
     7* [ CKEditor Localization]
© 2003 – 2017 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy