Contributing¶
Hi, thank you for visiting this page. The development of the open source software is comlicated and demanding. Users during their tests would be able to highlight our pitfalls and improve on them. People who contributed to the project would be added to the list of co-authors on the upcoming paper. How to do it? Here’s a quick guideline:
Bug reports and feature requests¶
Please, open the GitHub issue in the original Metagenomic-DeepFRI repository on GitHub. In issue, please provide a reproducible example and a description of the problem. The team of Metagenomic-DeepFRI developers will try to solve the problem.
Code improvement¶
If you spotted a bug or you want to improve the code yourself, please follow next steps:
Visit original Metagenomic-DeepFRI repository on GitHub
Fork the repository to your profile
Commit changes
Push changes to your fork
Open a new pull request
In pull request please describe in detail a rationale for your changes and how do they solve the problem. Responsible for PR acceptance: Piotr Kucharski.
All contributors with accepted PR’s will be included as co-authors in the upcoming paper.
Use-case reporting¶
You solved an intresting problem using our software? Or you benchmarked Metagenomic-DeepFRI against other software? Collect the figures and do a little write up about it. The report should be written in Markdown. When it’s finished, please follow this workflow:
Visit original Metagenomic-DeepFRI repository on GitHub
Fork the repository to your profile
Place the report in the
docs/source/examples
folderAdd your figures to
docs/source/examples/figures
folderEmbed figures in text - check links.
Modify
docs/source/examples/index.rst
adding the new report to a.. toctree::
Commit changes
Open a pull request
Responsible for use-case reports acceptance: Tomasz Kosciolek (@TomaszLabMCB) & Valentyn Bezshapkin (@valentyn_bez)
All contributors with accepted PR’s will be included as co-authors in the upcoming paper.