Currently there is some info in the contributing page and some other info in the advanced setup page of the install docs about how to set up your system as an MNE developer. This info should only be in one place. Also, the info on using GitHub to set up a pull request should also probably be incorporated in the same place.
@jasmainak suggests we make a CONTRIBUTING.rst file with (more detailed) info on system setup, and use the sphinx include:: directive to paste that file into one of the documentation pages.
@drammock has a bash script for system setup; parts of that could be added.
Questions:
-
how much content should go in CONTRIBUTING.rst? (i.e., just the code to set up your dev environment? basically all of the current contributor's guide? something in between?)
-
where in the docs should it be included? in the contributing guidelines page, or in the advanced installation docs?
cc @massich
Currently there is some info in the contributing page and some other info in the advanced setup page of the install docs about how to set up your system as an MNE developer. This info should only be in one place. Also, the info on using GitHub to set up a pull request should also probably be incorporated in the same place.
@jasmainak suggests we make a
CONTRIBUTING.rstfile with (more detailed) info on system setup, and use the sphinxinclude::directive to paste that file into one of the documentation pages.@drammock has a bash script for system setup; parts of that could be added.
Questions:
how much content should go in
CONTRIBUTING.rst? (i.e., just the code to set up your dev environment? basically all of the current contributor's guide? something in between?)where in the docs should it be included? in the contributing guidelines page, or in the advanced installation docs?
cc @massich