NDCLab / lab-devOps

NDCLab mgmt and operations
GNU Affero General Public License v3.0
0 stars 0 forks source link

gh-brainBox basics #30

Closed jessb0t closed 3 years ago

jessb0t commented 3 years ago

Create basic workflow concept for how new ideas (paper, tool) are shared and discussed within the lab.

jessb0t commented 3 years ago

Starting proposal. Please forgive/enjoy the coffee metaphor:

  1. Create repo called brainBox (like a suggestion box for brainy ideas). :smile:
  2. Develop a workflow for this repo. My initial idea is below:
    • one starts with a seedling of an idea (in my metaphor, this is a coffee seedling...)
    • this passes into a "budding" process that involves the individual formalizing their idea with a GH issue using a default template (please see #31); at the end of this "budding" process, the seedling is a more robust and the coffee beans can be harvested
    • the beans now enter a "roasting" process where they are submitted to external elements (like roasting coffee beans to bring out the best flavor); during this process, labmates can comment on the open GH issue to share their thoughts, raise concerns, etc.
    • the last stage in the process is a "brewing" process by which the person whose idea this is refines their original idea in light of the team discussion in order to effectively get a quaffable cup of coffee
  3. ZenHub workspace pipelines for this repo would mirror these three sub-processes.
  4. That cup of coffee at the end of the process is the "idea" input to the standard process flow for a new study or a new tool. It is completed with a pull request to George (who clearly has to be on onboard with dedicating lab resources to making the idea a reality). We will also need to formalize a PR template.

Screen Shot 2021-05-12 at 08.35.29.png

Let me know your thoughts. Purpose of this GH issue is to build out a basic idea; subsequent issues will be opened to implement into GH/ZH for lab-wide use.

jessb0t commented 3 years ago

@georgebuzzell @F-said Workflow idea posted here that goes with PR under #31. Please comment!

georgebuzzell commented 3 years ago

@jessb0t hold on, hold on, hold on. Did you come up with the coffee roasting metaphor?? Because I ABSOLUTELY LOVE THIS!!

I love this metaphor, but even more (or equally?) I LOVE the whole mechanism for how to set this up. That is, using a specialized zh workspace. This is, just, great! Please move forward with this 100% and let me know what questions you have and what you need!

jessb0t commented 3 years ago

I've set up the repo and ZH workspace as discussed and am closing this PR now.

georgebuzzell commented 3 years ago

@jessb0t Great! Please just make sure to link to the pr in your closing comment, and to assign me to the pr :)

(Sorry, I know I just commented the same thing on another issue, and you have not been able to see these messages yet, just commenting in both places for posterity and NOT because I don't think you will get the message). :)