community
community copied to clipboard
dask
Consolidation of contributing guides
I had a user ask me today about contributing guidelines on dask-kubernetes. That project doesn't currently have a CONTRIBUTING.md file and so I pointed them to https://docs.dask.org/en/latest/develop.html#contributing-to-code.
Having a look through the various projects in the Dask org there isn't much consistency when it comes to contributing guidelines. Some projects do not have a contributing file (dask, dask-kubernetes, dask-yarn, dask-jobqueue). Some have a minimal file which points to the Dask docs link above (distributed). And some have their own parallel set of contributing guidelines (dask-ml).
I think it would be good to go through the projects without a CONTRIBUTING.md file and add a minimal one which points to the main Dask docs. We may also want to consider whether we should unite the dask-ml and dask-docs ones into a single one, or whether the projects are different enough that they require two sets of documentation.
Thoughts?
+1 to uniting to the extent that dask-foo authors are comfortable with that. +1 to adding links.
In distributed we had a few additional concerns around async and testing that were important to add, but seemed out of scope for the general docs (although maybe this has changed). I imagine that the other downstream projects will have similar additions to make.
On Mon, Oct 14, 2019 at 8:56 AM Jacob Tomlinson [email protected] wrote:
I had a user ask me today about contributing guidelines on dask-kubernetes. That project doesn't currently have a CONTRIBUTING.md file and so I pointed them to https://docs.dask.org/en/latest/develop.html#contributing-to-code.
Having a look through the various projects in the Dask org there isn't much consistency when it comes to contributing guidelines. Some projects do not have a contributing file (dask, dask-kubernetes, dask-yarn, dask-jobqueue). Some have a minimal file which points to the Dask docs link above (distributed). And some have their own parallel set of contributing guidelines (dask-ml).
I think it would be good to go through the projects without a CONTRIBUTING.md file and add a minimal one which points to the main Dask docs. We may also want to consider whether we should unite the dask-ml and dask-docs ones into a single one, or whether the projects are different enough that they require two sets of documentation.
Thoughts?
— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/dask/community/issues/17?email_source=notifications&email_token=AACKZTFHQKHOX7TA57HCIGLQOSJEHA5CNFSM4JARBDAKYY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4HRUIEKA, or unsubscribe https://github.com/notifications/unsubscribe-auth/AACKZTA3BXXRCEY2IKUSHO3QOSJEHANCNFSM4JARBDAA .
I imagine for some cases you could link to the generic docs and then add some project-specific steps, although this does introduce some documentation indirection. So maybe if there are some additional build steps, or additional testing steps it makes sense to duplicate the whole lot at that point.
I think a good first step would be to add links and files to everything missing a CONTRIBUTING.md. I just wanted to check before I spam a load of projects with PRs.
I have now opened PRs against all actively used projects (as best as I can tell). Sorry for the noise for those subscribed!