Improve contributing tutorial documentation#486
Open
Jeebjean wants to merge 1 commit into
Open
Conversation
- Fix Dataset API example to use DatasetSchema instead of plain dict - Add pre-flight environment checklist to Prerequisites section - Add note about PAT workflow scope requirement in Step 7 Closes Reed-CompBio#480
ntalluri
reviewed
Jun 15, 2026
ntalluri
left a comment
ntalluri
left a comment
Collaborator
There was a problem hiding this comment.
This looks good to me. I left some questions on stuff that could be added or changed but they're more suggestions.
| docker login | ||
| conda --version | ||
| git --version | ||
|
|
Collaborator
There was a problem hiding this comment.
should we also add a check to make sure SPRAS conda env is ready?
Collaborator
There was a problem hiding this comment.
python -c "import spras; print('SPRAS import successful')" is what is in the spras tutorial.
|
|
||
| .. note:: | ||
|
|
||
| If you are using HTTPS to push and your commit touches files in |
Collaborator
There was a problem hiding this comment.
Can we just explicitly say for developers to use SSH to push to SPRAS in the contributing guide? And then add a warning that if you use https the issues you mentioned will happen.
| ``main`` branch of the fork stays synchronized with the ``main`` branch | ||
| of the main SPRAS repository. | ||
|
|
||
|
|
Collaborator
There was a problem hiding this comment.
Can we remove these new white space lines?
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Addresses documentation gaps identified in #480.
Changes made
DatasetAPI example in Step 3 to useDatasetSchemainstead of a plain dict (the old example fails with the current API)workflowscope requirement in Step 7Out of scope for this PR (team decisions needed)
cc @agitter
cc @ntalluri