Skip to content

Latest commit

 

History

History
43 lines (26 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

43 lines (26 loc) · 2.02 KB
Raw

Contributing

The bottom line is to reach out to DevOps in #dsp-devops-discussions before contributing.

This is a small project with a very short list of contributors and it's not as easy to contribute to as many other codebases.

If you'd like to add a theme, additional documentation is available in ./app/themes.

Running Locally

There's instructions for getting set up in README.md.

If you'd like to run against a local Sherlock:

npm run dev

If you'd like to run against Sherlock's dev instance, you can use Thelma:

IAP_TOKEN="$(thelma auth iap --project dsp-tools-k8s --echo)" SHERLOCK_BASE_URL='https://sherlock-dev.dsp-devops.broadinstitute.org' npm run dev

If you'd like to run against Sherlock's production instance, you can use Thelma here too:

IAP_TOKEN="$(thelma auth iap --echo)" SHERLOCK_BASE_URL='https://sherlock.dsp-devops-prod.broadinstitute.org' npm run dev

Testing

Currently, Beehive's automated testing is only for it's most critical logic -- forwarding IAP identity to Sherlock and CSRF protection. This should be some of Beehive's only logic: any business logic should exist in Sherlock, not here.

Testing of UI behavior is manual. DESIGN.md has more information on some of the choices made to lower the blast radius of changes and make this work.

If you're feeling like there's something in the UI you can't confidently test manually, in the past that's meant that the functionality needed to be moved to Sherlock.

Submitting Changes

PRs require a ticket in the title with CLIA risk and security impact description filled. The description must include a summary of the changes, an explanation of what testing was done (screenshots recommended), and a note on the risk of the change.

PRs require two approvals; dependabot PRs only require one (GitHub Actions will automatically lend one approval to make this work with branch protection rules).