Contributing
If you would like to enhance the documentation with your personal experiences, than please feel free to contribute here.
- reports and tipps on installing leihs
- reports and tipps on upgrading leihs
- other reports and tipps
Please follow these guidelines so that your contribution can be integrated as easily as possible:
- Look through the Issue list before you implement something, to make sure no one else is working on a similar feature.
- Create a fork of the leihs project.
- Base your changes off the
masterbranch. - Make your changes in your own fork of leihs.
- Write tests for your work and ensure they pass. See the READMEs of the respective submodule repos for some hints on how to do that.
- Flatten your changes into one single commit. Push to your own fork.
- Submit a pull request.
- If our review approves it and if it applies cleanly, we'll run the whole test suite on our CI and in case all is green, merge it as soon as we can.
If you have any trouble, do not hesitate to create a new issue under the 'question' tag and we'll try to help you.
Your code:
- Must not break any existing tests (checked by us on our CI server)
- Must satisfy our coding guidelines (checked by us on our CI server)
- Must be covered by new tests if it introduces new functionality
You can translate leihs into your language quite easily! See the Translation-Guide for instructions on how to create a translation.
You're not a programmer? No problem, your organization can sponsor a development company to create the features you need. Just look for a company that creates and maintains Ruby on Rails and Clojure web applications. Any of them should be able to help you. Make sure to point the company at this guide so that they know how to bring their changes back into the project.