Etiquette for providing references when discussing issues.

[BScheliga]

I think we should agree on some sort of standard for how we want provide references in discussions we have on Github. Hopefully, this will allow us later to retrieve the relevant references for the manuscript.

Generally, I would suggest: 1) that arguments or points made during a discussion, which are based on literature etc, should be backed up by the relevant citations or references. Especially, since we are all coming from
2) The different research backgrounds also means, that sometimes things need to be in simple language or in lay-terms. 3) When issues acronyms in issues and the following discuss, please ensure there spelled out at least inside the respective issue.

My suggestion for referencing in issues is similar to how nature does it (I think). Reference the relevant citation with just numbers in brackets (e.g. [1],[2]...[n]). And at the end of an Issue or comment on an issue. List the reference under "References" with the title and an link to the source material.

E.g. Random words with out any further purpose, but to display an example for referencing a website [1] or book/paper [2]

References: [1] Learn Python The Hard Way, 3rd Edition (accessed 19/03/2021) [2] Get me off Your Fucking Mailing List

[dblana]

Sounds good! On your point 2: Everyone should always use simple language - it's not "dumbing down", it's working collaboratively across disciplines 🤗