[sword-devel] I'd Like to Volunteer

[Greg Hellings]

Troy,

Welcome to the list.

On Fri, Nov 27, 2009 at 10:21 PM, Troy Melhase <troy.melhase at gmail.com> wrote:
> Greetings,
>
> I'd like to volunteer to help with the SWORD project.  I can write
> technical documentation.  I can write (a little) C++ code, and (very
> much) Python code.

BPBible is where most of the SWORD-related Python work gets done.  I
believe you'll hear from someone of its leaders soon.

>
> I've created libsword bindings for Python with SIP, and I'll send
> another message to the list with details.  In creating the binding,
> I've become familiar with the C++ header files and found a few small
> things that should be changed.  I'd like to start there, get those
> files a bit more tidy and documented.  Assuming I send diffs, what
> format and to whom do I send them?

Python bindings already exist, I think through the CORBA bindings, but
I'm not certain on that.  If you have patches you'd like to submit,
you can send them into our bug tracker (along with a ticket) as well
as submit them directly to this list.  Just a basic `svn diff >
patchfile.diff` is usually sufficient, as long as you're patching
against the SVN HEAD revision.  Improved documentation would be great.
 When a new version of the library is released I generally create
Doxygen documentation and post it to a subsection of the CrossWire
website.  http://www.crosswire.org/~ghellings/1_6_0classdocs/ is the
1.6.0 version of the docs.  If you're going to be updating the
documentation in the headers, putting it into Doxygen format would be
greatly appreciated. ;)

>
> Please let me know when/where/how I can start if the headers aren't a
> priority.  Thank you and may our
> Lord bless you,

Headers (documentation, really) are always a priority in my mind.
That's the place most developers will go in order to get the feel for
how they can interact with the library.  Sort of a "first impression"
of the code itself idea.

--Greg

>
> troy
>
> _______________________________________________
> sword-devel mailing list: sword-devel at crosswire.org
> http://www.crosswire.org/mailman/listinfo/sword-devel
> Instructions to unsubscribe/change your settings at above page
>