We, the mroonga development project, are doing Ticket Driven Development by using a BTS named Redmine.
The location of our Redmine site is the following.
Developments are done per ticket.
We would like to ask developers to register on the site above.
You can see our roadmaps in the following page. Generally speaking, we develop based on the roadmap.
We decide our roadmaps by discussing in off-line or on-line meetings.
Roadmaps specify the list of adding features in each version.
We manage the source code using git on github.
If you want to contribute, please make clone in read/write mode, and then commit and push please.
If you still do not have your account on github.com, please register.
We would like to develop in the following procedure.
We welcome your ideas about new features or changes of specifications. Please create a ticket first and describe your idea there.
For adding and running test codes, please refer the description below.
Generally speaking, we want to ask the assignee to handle whole the process, like design, implementation, test and documentations.
Then you ask other developers to review (especially in case of adding new features), and when it passes you add or update documents and the ticket can be closed.
For adding and updating documents, please refer the description below.
We release the software when all tickets of the roadmap are closed.
We do the following to release.
(This section will be moved to Release procedure (XXX not yet translated)).
Currently we are assuming the following development environments.
glibc 2.5 is used in Red Hat Enterprise Linux 5.
There are just a few source files for now, and we would like to keep it simple as possible.
Since we are still in the early stage of the development of mroonga, we will not make the documents of the specification of SQL queries for now.
Alternatively we consider our SQL tests and its expected results as the list of features and the definition of their specifications.
We use two kinds of regression tests to manage the quality of mroonga.
Before pushing to the repository, please always run the regression tests and confirm that you don't introduce any degradation.
You can invoke these two kinds of tests by "make check".
SQL tests are implemented as "sub test suite" for "mysql-test" in MySQL's regression tests. For the detail about how to add test cases or how to modify expected result files, please refer the following MySQL document.
For the detail about C/C++ unit tests, please refer the following cutter document.
We use Sphinx for the documentation of mroonga.
We write documents in ReStructuredText format and we convert them to HTML etc.
The source files of documents are files having .rst extension in "doc/ja/source" directory.
When you add or modify them, please try to build by "make html" etc. and confirm that no syntax error happens.
Documents are published in http://mroonga.org . Since we are using github's web site feature, they will be updated each time when HTML files are pushed to http://github.com/mroonga/mroonga.github.com repository. We push to mroonga.github.com repository after confirming the consistency between documents and current released version.
So you can just push to mroonga repository to push documents for each ticket.
To avoid the issue that directory names of sphinx's output cannot be used in github, we prepare sphinx2github.sh script in "doc/en/source" directory. When you commit to mroonga.github.com repository, please modify sphinx's output files by using this script beforehand.