chanzuckerberg / single-cell-data-portal

The data portal supporting the submission, exploration, and management of projects and datasets to cellxgene.
MIT License
64 stars 14 forks source link

Document engineering best practices for CI/CD #5245

Open atolopko-czi opened 1 year ago

atolopko-czi commented 1 year ago

Two major goals for this epic:

  1. Team-wide, discuss, document, and ratify best practices we intend to use to facilitate CI/CD. See [initial dev workflow proposal] (https://docs.google.com/document/d/1UyJS8wxkLvtACUM6mVUBUotwqEiX2iVOd_RGyzUN9NI/edit#bookmark=id.uu9u499m5nd3).
  2. Ensure that testing setup and techniques for all apps/components for both localhost- and RDev-based testing are well documented. There is a good deal of tribal knowledge surrounding how tests are run locally for various components of the CxG Platform. BE engineers often find it difficult to setup environment to run FE tests or FE servers, and vice-versa. There are also caveats with certain components or tests being run on Intel vs M1/2 Mac laptops.

Documentation should be added such that:

Implementation notes:

tihuan commented 1 year ago

Hey team! Please add your planning poker estimate with Zenhub @atolopko-czi @Bento007 @danieljhegeman @ebezzi