Remove items not relevant to documentation in PR template #234
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,21 @@ | ||
| # References and relevant issues | ||
| <!-- What relevant resources were used in the creation of this PR? | ||
| If this PR addresses an existing issue on the repo, | ||
| please link to that issue here as "Closes #(issue-number)". | ||
| If this PR adds docs for a napari PR please add a "Depends on <napari PR link>" --> | ||
|
|
||
| # Description | ||
| <!-- What does this pull request (PR) do? Does it add new content, improve/fix existing | ||
| context, improve/fix workflow/documentation build/deployment or something else? | ||
| <!-- If relevant, please include a screenshot or a screen capture in your content | ||
| change: "An image is worth a thousand words!" --> | ||
| <!-- You can use https://www.cockos.com/licecap/ or similar to create animations. --> | ||
| <!-- You can also see a preview of the documentation changes you are submitting by | ||
| clicking on "Details" to the right of the "Check the rendered docs here!" check on your PR.--> | ||
|
|
||
|
Comment on lines
-19
to
-21
There was a problem hiding this comment. No strong feelings here, but we did include this thinking of tooling/infrastructure PRs (dealing with sphinx, sphinx-gallery, CI etc). There was a problem hiding this comment. Don't feel strongly here either but would like to remove the checklist as I think doc only PRs would be most common and I never know what I am mean to do (with the irrelevant checklist items) in that case. Maybe a minor re-word also here to make these more relevant E.g., comment code so others know what it achieves Could we also add a 'if the PR relates to tooling/infrastructure changes:' before the items - because when I make a doc PR the first 2 items seem a bit awkward/confusing to me? |
||
| <!-- Final Checklist | ||
| - If images included: I have added [alt text](https://webaim.org/techniques/alttext/) | ||
| If workflow, documentation build or deployment change: | ||
| - My PR is the minimum possible work for the desired functionality | ||
| - I have commented my code, to let others know what it does | ||
| --> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm actually not sure about this. In documentation it is even more important to add images, so why not leave this in?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah I read this as add images to the github PR thread - e.g., over in napari, people may put a screenshot/video capture in a comment to demonstrate what their code does. I thought here, if an image is added we could just look at it in the file tab. Though now that I think about it maybe with lfs we won't be able to see the image? (I am really not familiar with lfs).
Maybe it is worth a slight re-wording to clarify what we mean (esp as I think we mean something different when we say this over in napari?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Related, do we have documentation on how to deal with lfs when contributing images in docs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We are not using lfs anymore, so this shouldn't be a problem. I read this comment as "Please add images to the documentation page you are writing if you can", but maybe I am missing the perspective of the user here - they may understand like you did. So not sure!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've updated it slightly and kept this, thanks for your review!