This document aims to ensure that contributing is as easy as possible, by providing some details on how to contribute to the project.
If what you are wondering about is not documented here¶
Please reach out to me personally on my email prv21fgt@bangor
Submitting issues or feature requests¶
If you discover a problem with the library feel free to submit an issue to our main repository. Please ensure that the issue is as detailed as possible to make resolving the issue as smooth as possible.
For feature requests, please ensure that the feature as not already been requested before submitting. If it has already been requested, feel free to voice your support on the relevant issue.
Implementing new features in the library¶
If implementing a new feature in the library, be that a metric, inference test, etc. please ensure that the need for the implementation is well-documented. Things that justify the inclusion includes but is not limited to:
Benchmarks that show that the implementation is faster or comparable to existing implementations.
Show that existing solutions have issues, including, but not limited to poor typing, poor performance, correctness issues, etc.
If applicable, please ensure that the feature is properly cited.
Documentation guidelines¶
If you want to contribute to the documentation, you are more than welcome to, but please bear the following in mind.
Use British English¶
I felt it had to be said, but please use British English, and please use s’es instead of z’s where applicable.
Use references were available¶
Where academic literature is available to verify claims, please use the bibliography to cite it.