search

monarch-initiative / monarch-ingest

Data ingest application for Monarch Initiative knowledge graph using Koza
https://monarchinitiative.org
15 stars 2 forks source link

New Ingest SOP #260

Closed sagehrke closed 2 years ago

sagehrke commented 2 years ago

This is a proposal for the Standard Operating Procedure to propose, approve, & create new Monarch ingests. Once this SOP is approved, we will add it to the contribute.md file in the ingest repo. Please review and comment on changes as necessary.

New Ingest SOP Draft:

  1. Propose an Ingest: create a ticket (on GitHub Ingest) that includes the name of the source and justification for it's inclusion in Monarch. Assign the ticket to Tim & PM. Who: Anyone can submit a proposal.
  2. Estimate Workload: Utilize planning poker to identify the amount of work the proposed ingest will be. Who: Monarch Technical Team (PM will initialize planning poker vote)
  3. Put up for vote & discussion: Use voting on github (thumb up for approve / thumb down for reject). Voting & discussion are open for 2 weeks. Who: Anyone can vote on a proposal (PM will initialize vote)
  4. If voted positive: assign to a team member, start working on ingest, then create a PR. Skip to Step 6. Who: Monarch Technical Team
  5. If voted negative, note why it was downvoted and close the issue. Who: Monarch Technical Team
  6. Disseminate the proposed model and gather feedback: Send an email to the Monarch Leads Google Group and the slack ingest channel (kg-monarch) requesting input. All discussions are done in GitHub on the PR - tag those that need to respond in a comment on the PR. The feedback stage is open for two weeks. Who: Monarch Technical Team member assigned to PR will disseminate the proposal. Anyone can comment or suggest input.
  7. Deploy the new ingest. Who: Monarch Technical Team
monicacecilia commented 2 years ago

Thank you, @sagehrke! This contains all the details we discussed. Now that @putmantime has approved, our next step is to add this to the Ingest documentation.

I suggest we create a new file named Propose.md with this information. The most logical repository for this to live seems to be https://github.com/monarch-initiative/monarch-ingest/tree/main/docs/Create-an-Ingest -- this way it will show up as a page on our Docs site for the ingest, here.

If you would like to work on this, here is a handy guide for Mastering GitHub Markdown. The text will be very similar to what you created in this ticket. 😉 Please let me or Tim know if you would need any assistance.

monicacecilia commented 2 years ago

p.s.: we can close this ticket and open a PR with the new file.