Skip to content

Contribution

Sivasurya Santhanam edited this page Jun 21, 2018 · 8 revisions

You can contribute to the project in many ways. The least of them require code in any form of you.

This site is under construction and need additional information for all points

Be involved

Contributing Code

We are happy for every help we get. You can provide features, bugfixes, test, documentation or examples. It would be nice if you could provide all together, but if you don’t submit it nonetheless, someone else may improve it. To cite "Yonik Seeley’s (Solr committer) Law of Patches"

"A half-baked patch […], with no documentation, no tests and no backwards compatibility is better than no patch at all."

To set up your developing environment please see at the development documentation KnowledgeFinder - Developer Documentation

Making changes

Before you start you might want to discuss your proposed changes on the dev mailing list or in the issue tracker. This will improve the chances for the change being accepted.

For lager scale changes please use the possibilities of git and github to create new branches or fork the repository.

Please take care about the following points:

  • Code should follow the Code Guidelines

  • The project should pass existing tests

  • it would be nice if you provide unit test to demonstrate bugs, fixes and features

  • Take in account our non-functional requirements.

Finally create or update your pull request

Clone this wiki locally