7. How to contribute
The basic things "everyone" can do are:
- complete missing words in concrete syntaxes
- add new abstract words in
Words
and greetings inGreetings
The missing concrete syntax entries are added to the Words
L.gf
files for each language L. The morphological paradigms of the GF resource library should be used. Actions (prefixed with A
, as AWant
) are a little more demanding, since they also require syntax constructors. Greetings (prefixed
with G
) are pure strings.
Some explanations can be found in the implementation document, which is produced from the concrete syntax files SentencesI.gf
and
WordsEng.gf
by make doc
.
Here are the steps to follow for contributors:
- Make sure you have the latest sources from GF Darcs, using
darcs pull
. - Also make sure that you have compiled the library by
make present
ingf/lib/src/
. - Work in the directory
gf/examples/phrasebook/
. - After you've finished your contribution, recompile the phrasebook by
make pgf
. - Save your changes in
darcs record .
(in thephrasebook
subdirectory). - Make a patch file with
darcs send -o my_phrasebook_patch
, which you can send to GF maintainers. - (Recommended:) Test the phrasebook on your local server:
a. Go to
gf/src/server/
and follow the instructions in the project Wiki. b. Make sure thatPhrasebook.pgf
is available to you GF server (see project wiki). c. Launchlighttpd
(see project wiki). d. How you can opengf/examples/phrasebook/www/phrasebook.html
and use your phrasebook!
Finally, a few good practice recommendations:
- Don't delete anything! But you are free to correct incorrect forms.
- Don't change the module structure!
- Don't compromise quality to gain coverage: non multa sed multum!
- Printer-friendly version
- Login to post comments
- Slides
What links here
No backlinks found.