Chemfiles is an open-source project, that I make on my free time. Any contribution, from documentation improvement to new features including bug fixes are very welcome!
Lot of things! Just pick one considering the time you can spend, and your technical skills.
There are multiple way to improve the code. You can either pick up a TODO in the code, or any issue in the list. If you plan to add a new feature which is not in the issue list, please open a new one so that every one knows you are working on it, and so that the implementation can be discussed!
This documentation try to be easy to use, but there is always room for improvements.
You can easily edit any .rst
file on the github repository, and propose your changes
even with no git knowledge. All you need is a Github account.
A few external projects are used in chemfiles developement, and you will need a bit of knowledge of them to contribute. Depending on what you want to do, not all these projects are needed.
When writing code for chemfiles, please respect the overall coding style. This is not
only a question of style, but make it easier to enter in the project if all the files
are formatted consistently. Do not use non standard features of any programming
language unless there is no other way to do it. In that case, please wrap the code in
#ifdef
macros, and add cases for at least Linux, OS X and Windows. You should add
unit tests for each new piece of code, they will be run on travis before your
changes are merged.
Git messages should be informatives, and describe the what, not the how. If your
commit concern the documentation, please add the [doc]
at the beggining of the
message.
Happy coding!