update directory structure requirements #943
Merged
Conversation
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
link destination was blank -- added link to take users to version 3.1.2 of docs.
suggest we use `code` instead of `src` for the subdirectory to contain scripts, notebooks, etc as this is a more self-explanatory name for learners who are new to this field if they're poking around in the repo trying to find things. (Not a single one of our modules currently follows this rule anyways, so it will be the same amount of work to bring into compliance either way).
update QA templates to include up-to-date directory structure standards.
upversion docs, add old version to previous versions list, remove older versions so only 3 most recent priors are shown.
rosemm
approved these changes
Sep 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
data folder technically new to docs, but already in use.
Also, changed
srctocodebecausesrcis not being used by anyone yet (mostlynotebooksis in use, but that isn't well named for non-notebook files), so it will require the same amount of edits to bring up to standards either way, andcodeis more self-explanatory for learners who might poke around in our repo on their own to try to find materials.Made edits to the QA templates for now, though won't be long until we can deploy the action that looks for this, at which point we should be able to just remove that section from the manual QA process all together.