Casbah has a growing community and contributions are always encouraged. Contributions can be as simple as minor tweaks to the documentation. Please read these guidelines before sending a pull request.
Before starting to write code, look for existing tickets or create one for your specific issue or feature request. That way you avoid working on something that might not be of interest or that has already been addressed.
Casbah currently supports Scala 2.9.X.
Casbah aims to follow the Scala style conventions including 2 space indents and 79 character line limits.
- Avoid backward breaking changes if at all possible.
- Write inline documentation for new classes and methods.
- Write tests and make sure they pass (make sure you have a mongod running on the default port, then execute
./sbt testfrom the cmd line to run the test suite). - Add yourself to AUTHORS.rst :)
To contribute to the API documentation just make your changes to the inline documentation of the appropriate source code or rst file in a branch and submit a pull request. You might also use the github Edit button.