-
Notifications
You must be signed in to change notification settings - Fork 81
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Flesh out contributing docs to include pre-commit, style, build info, more #449
Comments
@mfisher87 Is this relevant? Do you have any specific opinions about this? |
Yes, I think most of this is still relevant. I think this can all go in the contributing index doc? Not sure; I don't want that doc to get too big again, so open to suggestions :) Updated the original post! Let me know if there are still unanswered questions! |
I think we should include this in contributing index doc since the topics discussed here would be in contributor interest :) |
Hey should we assign an entirely different section addressing these points? I wonder which is the section where all of these fit together |
Do you mean a section within the contributing index doc? We could update the "format and lint" section to use pre-commit instead of Make. Perhaps for the docs stuff, we add a subsection "... to contribute to docs"? Perhaps for conda v poetry, we could add a section for "development environment management". Where do we tell contributors how to use poetry to install a development environment? I don't know how personally (and I think we should switch away from poetry ;) ). I don't know that we actually document that currently, so I think we might need new content. |
Yeah I mean sections under contributing index doc. I agree with all the suggestions and maybe we can put the poetry issue on hold for now and once things are sorted then we can add the add it later. |
I think that sounds like a great path forward, thank you @Sherwin-14 :) Would you like to be assigned to this issue? |
Yes I would be glad :) |
What elements are needed or out of date in CONTRIBUTING.md? For example, we should probably document:
pre-commit install
to enable it to run automatically;pre-commit run -a
to run manuallyscripts/docs-live.sh
andscripts/build-docs.sh
. Video tutorial: https://www.youtube.com/watch?v=mNjlMZ4F3Soscripts/docs-live.sh
, it won't autoreload when you change a docstring in the code. Hot reloader only watches the docs themselves for changes)The text was updated successfully, but these errors were encountered: