Skip to content
This repository has been archived by the owner on Jun 21, 2023. It is now read-only.

Add "modules at a glance" table #345

Merged
merged 9 commits into from
Dec 18, 2019

Conversation

jaclyn-taroni
Copy link
Member

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? 😬 )

@jaclyn-taroni jaclyn-taroni added the documentation Improvements or additions to documentation label Dec 17, 2019
analyses/README.md Outdated Show resolved Hide resolved
Copy link
Member

@jashapiro jashapiro left a 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?

jaclyn-taroni and others added 2 commits December 18, 2019 13:55
@jaclyn-taroni
Copy link
Member Author

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?

@jashapiro
Copy link
Member

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.

README.md Outdated Show resolved Hide resolved
Co-Authored-By: jashapiro <jashapiro@gmail.com>
@jaclyn-taroni jaclyn-taroni merged commit 771f0a2 into AlexsLemonade:master Dec 18, 2019
@jaclyn-taroni jaclyn-taroni deleted the analyses-readme branch December 18, 2019 19:48
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants