Add more information in the contribution guide
From https://the-turing-way.netlify.app/ add links for:
-
https://the-turing-way.netlify.app/reproducible-research/vcs.html -
Fix issue #428 (closed) -
Fix issue #511 (closed)
From @benkelaar :
-
How to test section is duplicated -
Performance & CI testing sections are "TBW" -
tox is used in examples extensively but never explained -
Backwards compatibility is mentioned in several places, but I couldn't find a versioning and/or deprecation strategy. The 1.0.0 changelog mentions semver notation, but not actually the strategy, which is the more powerful aspect, especially when supporting a large user-base. If I just didn't look hard enough for it, it might be good to link to that strategy from those sections. -
Code formatting mentions only flake8 in the beginning but then lists a whole range of tools, some of which are explained later in the text, but that doesn't make that section easier to understand. -
Creating a development environment mentions building with or without pygmo
but no mention is made anywhere why or why not you would want to build with pygmo. The reasoning might be that if you don't know what it is you probably don't want it, but even adding that as a remark will make it less confusing I think.
Edited by Constanze Nghiem