[rekonq] Re: Contributing to Rekonq -> update the website?

[Pierre Rossi]

On Fri, Jan 28, 2011 at 17:33, Benjamin Poulain
<benjamin.poulain at nokia.com>wrote:

> Hello,
>
> May I suggest to add some text on http://rekonq.kde.org/sources to guide
> people on contributin to Rekonq?
>
> I think it is important to guide people on how to do their first
> patches. It shows our process is quite complicated and it could be an
> objective for us to simplify some particularity so the text can be made
> simpler.
>
> I suggest the following:
>

Indeed, very nice thing to have on the website:

It seems you hesitated a bit between "Rekonq" or "The Rekonq project"
though, I guess it should read:


>
> -------------------------------------
>
> <h1>Contributing to Rekonq</h1>
>
>  Rekonq is open to all contributions, from small fixes to full time
> commitment. The patches should follow the vision of the project, and the
> quality defined for the code.
>
> The main communication channels for developers are
> * the mailing list https://mail.kde.org/mailman/listinfo/rekonq
> * IRC: #rekonq on Freenode
>
*Here I'd add:*
   Don't hesitate to discuss your plans of adding features there beforehand.


>
> To compile Rekonq, you need recent kdelibs with the development
> headers. Here are the commands to compile and install Rekonq from source:
>
> <pre>
> git clone git://git.kde.org/rekonq.git
> cd rekonq
> cmake .
> make
> sudo make install
> </pre>
>
> When making a patch, follow the KDE coding style:
> http://techbase.kde.org/Policies/Kdelibs_Coding_Style except for braces
> which have to be on the next line:
>
> <pre>
> // Correct
> if (foo)
> {
>
> while (bar)
> {
>
>
> // Wrong:
> if (foo) {
> </pre>
>
>
> Once you made a patch, use "git commit" to create a commit. The commit
> message needs to be a clear description of the change introduced by the
> patch. If necessary, split the change in smaller patches introducing one
> feature at the time.
> More information about commit messages can be found here:
> http://techbase.kde.org/Projects/rekonq/Git_with_rekonq_HowTo
>
>
> Every non-trivial patch needs to be reviewed by at least one developer
> of the project. This is done on the review board:
> http://git.reviewboard.kde.org/
> Create the text verson of patch with git format-patch, and submit it on
> the review board. To create an account on review board, use
> https://identity.kde.org/.
>
> Making a perfect patch usually takes a few reviewing iterations. Do not
> give up if your patch is not accepeted immediately. If the review has no
> comments after a few days, ask why on #rekonq.
>
> Once a reviewer accept a patch, he will integrate it for you.
>
> Regular contributors are granted commit rights so they can pushes patch
> themself. The review process is mandatory for everyone, including
> commiters.
> _______________________________________________
> rekonq mailing list
> rekonq at kde.org
> https://mail.kde.org/mailman/listinfo/rekonq
>


No other remarks really. I think it'd be a great page to have. :)

Cheers,
--
Pierre
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.kde.org/pipermail/rekonq/attachments/20110128/de0ab8ca/attachment-0001.htm