Contribute to OASIS project
Help spread the word
The best way to help the OASIS project is to use it, of course. From the beginning, OASIS has been designed using real-life projects as examples to define features. The first public version was the one matching the most common requirements of the author's projects. It is now time to expand this requirements to your projects as well.
- Try OASIS on your libraries/programs
- If it doesn't work out of the box, you can try to fix the generated files
- If you are able to solve the problme by yourself, send us your fix for inclusion
- If it doesn't work for you, you can ask for help:
- on the IRC channel #ocaml on freenode (nickname: gildor)
- on the caml-list mailing list with subject containing "OASIS help" (caml-list AT inria.fr)
- on the caml-beginner mailing list with subject containging "OASIS help" (ocaml_beginners AT yahoogroups.com)
Get involved into development
To get a copy of the source tree, you must use git anonymously:
$> git clone git://github.com/ocaml/oasis.git
You can send back patches using git. Create an account on github, fork the project, push your changes to your github copy and submit a "Pull Request". To push your changes, if your github user is USERNAME, first add a new remote location to your local repository (you have to do that once only):
$> git remote add github firstname.lastname@example.org:USERNAME/oasis.git
and then push your master branch to it:
$> git push github master
Alternatively, you can send your patch to the mailing list:
$> git format-patch -M --email@example.com origin/master
or with a bug report.
To update the source code with the latest available version:
$> git pull
OASIS uses ocaml-gettext for internationalization support. If you want to translate it to another languages, just fetch the
.pot files and start translating.
Once done, you can submit a bug report or send us an email so that we can include your work into the next version of OASIS.
Write plugins and tools
If your requirements cannot be fulfilled by the actual code, you can extend OASIS features through plugins. For now, plugins development need to be done with the OASIS source tree.
- Get a copy of the OASIS source tree (see next section)
- Add a directory into
- Add an "open" statement in
- Create a test into
test/dataand call it from within a test case (see
- Create your plugin
Writing tools is not yet very easy. You need to depend only on the content of
src/oasis, which should become a library soon. Theses files contain everything needed to parse and extract information from an
_oasis file. You can also subscribe to the oasis-devel mailing list.