I would like to suggest that unit/functional/integration tests would be the
best solution for this. I know it's not easy to get into a testing culture,
but various projects including parts of SMW are adopting this. It solves
these problems:
1. provides clear examples of how to do things using SMW without having to
wade through conversations that may have outdated information
2. validates the current functionality of those examples, which is a huge
issue with constantly changing code
3. provides a way to reliably migrate code bases to a more self contained
state
4. provides a way to know which extensions will work with current releases
of SMW past "eyeballing"
and is also very useful for fine grained performance analysis.
I'd suggest that beginners working with experts should be encouraged to
create tests as a way to understand the current code base, and that running
tests suites should be a standard activity in releases. Jenkins and Travis
(hosted) are two continuous integration platforms.
Here's a good summary of different types of tests:
http://stackoverflow.com/questions/4904096/whats-the-difference-between-unit-functional-acceptance-and-integration-test
ideally all will be represented, but in a worse case mid level common case
integration tests would be very helpful.
David
On 9 May 2013 13:08, Yury Katkov <katkov.ju...@gmail.com> wrote:
> (I've changed the subject name. See previous e-mails if you need a
> context.)
>
> *PROBLEM*: Nobody understand how SMW works and how to inprove it, except
> 2-4 core developers. The documentation of the code is not sufficient for a
> new deloper to quickly start participating in SMW development.
> *GOAL*: Eliminate the barriers that hinder new developers from
> participation. Create the documentation for the programmers but waste
> minimum of core developers' time.
> *IDEA*: Organize a hangout/webinar where the gurus describe the basic
> concepts in the code, relations between the main classes in SMW and ways to
> implement the common use cases of improving SMW.
>
> *PLANNED RESULTS: *
> 1) videorecord of the webinar
> 2) Architechture Guide improved by webinar participants
> 3) Some howtos on how to solve real problems in SMW.
>
> I think we can create a wikipage of the topics that can be discussed on
> such webinar. This can also be used in SMW tutorials on the next SMWCon.
>
> -----
> Yury Katkov, WikiVote
>
>
>
> On Thu, May 9, 2013 at 8:31 PM, Jeroen De Dauw <jeroended...@gmail.com>wrote:
>
>> Hey,
>>
>> Maybe smth like webinars or google hangouts with core developers could be
>>> an option? I understand that it's easier to describe the architecture
>>> verbally than to write a guide. I'm volunteering to do the technical
>>> writing job, I think I know at least two more developers who also can help
>>> with writing down.
>>>
>>
>> I'd be happy to join such a hangout.
>>
>>
>> Cheers
>>
>> --
>> Jeroen De Dauw
>> http://www.bn2vs.com
>> Don't panic. Don't be evil.
>> --
>>
>
>
>
> ------------------------------------------------------------------------------
> Learn Graph Databases - Download FREE O'Reilly Book
> "Graph Databases" is the definitive new guide to graph databases and
> their applications. This 200-page book is written by three acclaimed
> leaders in the field. The early access version is available now.
> Download your free book today! http://p.sf.net/sfu/neotech_d2d_may
> _______________________________________________
> Semediawiki-devel mailing list
> Semediawiki-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/semediawiki-devel
>
>
------------------------------------------------------------------------------
Learn Graph Databases - Download FREE O'Reilly Book
"Graph Databases" is the definitive new guide to graph databases and
their applications. This 200-page book is written by three acclaimed
leaders in the field. The early access version is available now.
Download your free book today! http://p.sf.net/sfu/neotech_d2d_may
_______________________________________________
Semediawiki-devel mailing list
Semediawiki-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/semediawiki-devel