G-Golf uses Git for revision control, hosted
on Savannah, you may browse the
sources repository here.
You may participate to G-Golf in different ways: you
may want to just follow the project, to try it and report your impressions, to give us
some constructive feedback, or you may decide to actively contribute
to G-Golf, which could be contributing to the documentation,
the source code, the test-suite or all.
Actively contributing to G-Golf source code - in
addition to have a reasonably good Guile scheme knowledge and
practice - requires that your are at least familiar, but preferably that
you have a good knowledge of the GObject Introspection, GObject and Glib libraries.
G-Golf high level API extensively use GOOPS,
the Guile Object Oriented System.
If you want to contribute to G-Golf, please install from the source, then:
- Checkout the devel branch
- cd <to-your-g-golf-git-repo>
- git checkout devel
- Build and read the documentation (in the source tree) - its
content his (so far) especially dedicated to ourselves, potential
contributors and future maintainers.
Everyone has their own documentation format preferences,
feel free to adapt, here is how you would (source tree) build the html
doc - using the distributed enhanced css file provided by G-Golf:
- cd doc
- makeinfo g-golf.texi --html -c DOCTYPE='<!DOCTYPE
html>' --css-ref=../css/manual.css -o g-golf.html
To browse it (use your favorite browser of course, our is
- epiphany g-golf.html/index.html &
- Read (at last partially) the source code and get yourself
familiar with our coding and naming conventions.
- Read at least a few commits, and get yourself familiar with
our commit conventions. We have no specific document about this (yet),
but we (try to) follow Guile and Guix commit style
- Try G-Golf: everything that exists is working. You
will find some examples in the test-suite (which constantly needs to be
improved as well, we are working on it, but contributing to the
test-suite is welcome to).
G-Golf high level API will be (as far as possible)
compatible (or at the very least, will deeply 'mimic') Guile-Gnome.
and send these patches to:
Please use 'G-Golf - ' to preceed the subject line
of G-Golf related emails, thanks!
G-Golf uses the following bug reports mailing list: