wiki:DeveloperInformation

Version 22 (modified by Nicklas Nordborg, 16 years ago) ( diff )

Removed links to trunk versions since there is no published trunk dokumentation

  1. Developer documentation
    1. Development plan
    2. Code examples
    3. I want to contribute
    4. Release procedure
    5. Test data
    6. robots.txt

Developer documentation

Development plan

The development plan is available in the ​Roadmap section above.

Code examples

Code examples can be found on the BASE plug-ins site ​http://baseplugins.thep.lu.se/wiki/PluginDownload#Examplecode.

I want to contribute

Please send an email to the basedb-devel@… mailing list! If you are not subscribed to the list, you should first ​register your email address. Tell us what you want to do, download the source using subversion and hack away. There is a growing ​list of ideas for future development in BASE.

From the ​Subversion book: If you think that your work is usable for the rest of the community, you should donate your changes to the project After making your modifications to the source code, compose a clear and concise log message to describe those changes and the reasons for them. Then, send an email to the developers list containing your log message and the output of svn diff (from the top of your Subversion working copy). If the community members consider your changes acceptable, someone who has commit privileges (permission to make new revisions in the Subversion source repository) will add your changes to the public source code tree. Recall that permission to directly commit changes to the repository is granted on merit - if you demonstrate comprehension of Subversion, programming competency, and a "team spirit", you will likely be awarded that permission.

Release procedure

ReleaseProcedure -- instructions on how to perform a new release

Test data

We have a repository for core developers only with BASE test data. This data is needed for running some of the test programs in BASE, the tests will compile without access to the data. The reason to have this restriction is that some data is proprietary and we cannot disclose it. Core developers should use this command in their base working copy root directory:

svn checkout http://dev.thep.lu.se/basetestdata/svn/trunk/ testdata

robots.txt

The web page indexing robots are killing the web server since the robots index every revision of the source. There is a RobotsTxt file with information to well behaved robots. The contents of RobotsTxt is the same traditional robots.txt, and the ​RobotsTxtPlugin plug-in will serve a ​http://base.thep.lu.se/robots.txt to the robots.

Note: See TracWiki for help on using the wiki.