This repository has been archived by the owner on Jun 21, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 83
Add "modules at a glance" table #345
Merged
jaclyn-taroni
merged 9 commits into
AlexsLemonade:master
from
jaclyn-taroni:analyses-readme
Dec 18, 2019
Merged
Add "modules at a glance" table #345
jaclyn-taroni
merged 9 commits into
AlexsLemonade:master
from
jaclyn-taroni:analyses-readme
Dec 18, 2019
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
jashapiro
reviewed
Dec 18, 2019
jashapiro
approved these changes
Dec 18, 2019
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.
Looks good. Should we add a checkbox in the PR template to update this table as analysis are added/change?
Co-Authored-By: jashapiro <jashapiro@gmail.com>
What do you think of the wording in 43489e5 @jashapiro ? If we do that should we add something to the main README instructions as well? |
I suppose we should. |
jashapiro
reviewed
Dec 18, 2019
Co-Authored-By: jashapiro <jashapiro@gmail.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Purpose/implementation Section
I personally merge many of the pull requests that come through this repository. As a result, I have a working knowledge of what modules consume which files and how modules are interdependent/which modules create files consumed by other analyses. I am documenting that knowledge via a table that I'm terming the "modules at a glance" table, which I am adding to the README for
analyses
here. It is intended to make it easier for other project organizers and reviewers to get quickly get an overview of all of the modules.It is designed to note a module's name, what files it uses as input, a high-level description of what the module does and its status, and what output files it produces that other modules rely on. I think this is going to be easier to maintain than some kind of chart.
What GitHub issue does your pull request address?
Related to the "what data analyses consume" part of #336 (comment)
Directions for reviewers. Tell potential reviewers what kind of feedback you are soliciting.
Is there anything that you want to discuss further?
Will this modules at a glance table reduce the burden for other project organizers? How can it be improved? (Also did I successfully list all the
analyses
directories? 😬 )