Skip to content
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

update contribution guide #1320

Merged
merged 4 commits into from
Aug 10, 2023
Merged

update contribution guide #1320

merged 4 commits into from
Aug 10, 2023

Conversation

maliagehan
Copy link
Member

add tutorial contribution guide and table of contents

Describe your changes
Updates contribution guide to add a table of contents because it's long and also adds a contribution guide for adding tutorials.

Type of update
Is this a:

  • Update to documentation

Associated issues
#1299

Additional context
Add any other context about the problem here.

For the reviewer
See this page for instructions on how to review the pull request.

  • PR functionality reviewed in a Jupyter Notebook
  • All tests pass
  • Test coverage remains 100%
  • Documentation tested
  • New documentation pages added to plantcv/mkdocs.yml
  • Changes to function input/output signatures added to updating.md
  • Code reviewed
  • PR approved

add tutorial contribution guide and table of contents
@HaleySchuhl
Copy link
Contributor

Thanks for adding this Malia!

I think we could add some clarification to the part about adding tutorials. I found that the most straightforward way to clone the tutorial template structure into a new repo is by making a completely empty repository, and then using this option on GitHub.com, providing them with the link to plantcv-tutorial-template. It's the option at the bottom of the page and looks like this..
image

maliagehan and others added 3 commits August 3, 2023 10:10
update to include the import template option when you create a repo. Thanks Haley for the suggestion
@codecov
Copy link

codecov bot commented Aug 10, 2023

Codecov Report

Merging #1320 (08a610f) into release-4.0 (18e4b6d) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@              Coverage Diff              @@
##           release-4.0     #1320   +/-   ##
=============================================
  Coverage       100.00%   100.00%           
=============================================
  Files              157       157           
  Lines             6757      6757           
=============================================
  Hits              6757      6757           
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@nfahlgren nfahlgren added documentation Documentation issues or features ready to review labels Aug 10, 2023
@nfahlgren nfahlgren added this to the PlantCV v4.0 milestone Aug 10, 2023
@nfahlgren nfahlgren merged commit 91fefe0 into release-4.0 Aug 10, 2023
5 checks passed
@nfahlgren nfahlgren deleted the add-tutorial-guide branch August 10, 2023 01:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation issues or features ready to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants