Mailing-List: contact dev-help@openoffice.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@openoffice.apache.org
Received-SPF: pass (nike.apache.org: domain of liushenf@gmail.com designates
 74.125.82.49 as permitted sender)
MIME-Version: 1.0
In-Reply-To: 
 <CAP-ksojGZmAq2WS02SPGy_+dnfYdrW7pKD3+o_LZ6BvhVk_UDw@mail.gmail.com>
References: 
 <CAP-ksoj+wz0AmubYLC+_4Pa-wp5p_49v=A=GYfCdRnqVONwMFQ@mail.gmail.com>
	<50F516DA.9010301@googlemail.com>
	<CAP-ksoidkVWoJzGU+7+VppgjKgNA=dVEBEzP2oc+seSoCPvXvA@mail.gmail.com>
	<50F57D5B.90001@t-online.de>
	<CAP-ksojGZmAq2WS02SPGy_+dnfYdrW7pKD3+o_LZ6BvhVk_UDw@mail.gmail.com>
Date: Wed, 16 Jan 2013 22:56:21 +0800
Message-ID: 
 <CANQgRaa2TSr=Qy8mxaMf6w761TSQUxfrfxZAXbZ7pnp_LH+7cg@mail.gmail.com>
Subject: Re: (Draft) Introduction to Development module
From: Shenfeng Liu <liushenf@gmail.com>
To: dev@openoffice.apache.org
Content-Type: multipart/alternative; boundary=f46d043bdf38d7671204d3691433

--f46d043bdf38d7671204d3691433
Content-Type: text/plain; charset=ISO-8859-1

2013/1/16 Rob Weir <robweir@apache.org>

> On Tue, Jan 15, 2013 at 11:01 AM, Regina Henschel
> <rb.henschel@t-online.de> wrote:
> > Hi Rob,
> >
> > Rob Weir schrieb:
> >
> >> On Tue, Jan 15, 2013 at 3:44 AM, Oliver-Rainer Wittmann
> >> <orwittmann@googlemail.com> wrote:
> >>>
> >>> Hi,
> >>>
> >>>
> >>> On 14.01.2013 20:01, Rob Weir wrote:
> >>>>
> >>>>
> >>>> http://openoffice.apache.org/orientation/intro-development.html
> >>>>
> >>>> The idea here is to have a dev-focused introduction page that works
> >>>> along side the similar pages we have for Marketing and QA.  This is
> >>>> the first draft.   I already see a few typos, so don't worry about
> >>>> those.   But I am looking for more content.
> >>>>
> >>>> What else should we put here?  Any other links?  Any other startup
> >>>> tasks?
> >>>>
> >
> > There exists different type of "development":
> > - changing the core
> > - using AOO in other applications
> > - adding functionality to AOO via extensions and macros
> >
>
> Right.  It is a term with several meanings.  But only the first one
> involves a volunteer contributing to the project, so it should be
> clear from the context.
>
> > Your text addresses only "changing the core". That is likely correct,
> when
> > someone reaches that page following a hierarchical instruction. But
> nowadays
> > pages are more often found by searching.
> >
>
> Good point.
>
> > So my suggestion is, to make a short page for the other type of
> development
> > and add at the beginning of your text, the target audience of your page
> and
> > a reference to the other page.
> >
>
> Right now, when I search Google for 'OpenOffice development' I get this
> page:
>
> http://www.openoffice.org/development/
>
> That looks like a mix of topics, but need to be updated.
>
> Regards,
>
> -Rob
>
> > I don' know, whether an introduction page for the other kind of
> development
> > already exist. But it should contain hints to:
> > - api@openoffice.apache.org
> > - existence and download of SDK
> > -
> http://www.openoffice.org/api/docs/common/ref/com/sun/star/module-ix.html
> > - http://wiki.openoffice.org/wiki/Documentation/BASIC_Guide
> > -
> >
> http://wiki.openoffice.org/wiki/Documentation/DevGuide/OpenOffice.org_Developers_Guide
> > [- http://wiki.openoffice.org/wiki/Using_Cpp_with_the_OOo_SDK, if it
> will be
> > continued]
> >
> >
> >
> >>>
> >>> I think it makes sense to include the link to the OpenGrok instance
> from
> >>> Adfinis Sygroup [1] which can be also used to "inspect" the source
> code.
> >>>
> >>> [1] http://opengrok.adfinis-sygroup.org/source/
> >>>
> >>>
> >>
> >> Thanks!  I made changes, mainly additions, based on your feedback and
> >> earlier comments from Kay and Jan.  Here is the updated version:
> >>
> >> http://openoffice.apache.org/orientation/intro-development.html
> >
> >
> > The section 'Other Useful Resources' should have a link to
> > http://wiki.openoffice.org/wiki/Source_code_directories
> > and
> > http://wiki.openoffice.org/wiki/Coding_Standards
> > and
> > http://wiki.openoffice.org/wiki/Writer/Code_Conventions
> > However, they seem to need revision and additions. But they are useful
> for
> > newcomer nevertheless.
> >
>
> OK.  I created new sections for "Orienting Yourself" and "Coding
> Standards".
>
>
> > A hint to Doxygen for LibreOffice. The tool is helpful and it would be
> nice
> > to have a similar thing for AOO. If a module has it, you can get it when
> you
> > click on the module name in http://docs.libreoffice.org/ and then on
> > 'Doxygen'. Try it for example with module 'sd'.
> >
>
> I agree, that would be nice.
>
> Does anyone have any hints for debugging?  Or do we even have a page
> on debug logging/tracing?  For easy hacks it is probably sufficient to
> insert debugging log statements and debug things that way.
>
> -Rob
>

Rob,
  The page looks great! Of course there are more detailed guidance that we
need to add or update (e.g. debug, build...), but we can complement them
gradually.

  We already have a volunteer directory wiki[1], and I think we should
encourage them to register.
  And further more, I'm thinking if we should create a new wiki page and
give a checklist for new developers to record their progress, e.g. "build
successfully on xx platform", "can debug", "submitted n patch(es)".
    (1) For themselves, it will be great to feel their own progress with
regular milestone achievements.
    (2) For other new comers, this page can be a good reference to get help
and exchange the experience, who still has fresh memory to some of the pain
that old members might forgot already. :P
    (3) For community, it is definitely good to know where are our new
comers. e.g. If few new volunteers recorded "build successfully", we need
to check with them and review if our document is not adequate...

  Just my 0.02$.

[1]
https://cwiki.apache.org/confluence/display/OOOUSERS/Directory+of+Volunteers


- Shenfeng


>
> >
> > Kind regards
> > Regina
> >
> >
> >
> >
>

--f46d043bdf38d7671204d3691433--