From 4b3e2a0f69defc2cdb456081cd751e74559bab54 Mon Sep 17 00:00:00 2001 From: George Karr Date: Fri, 7 Mar 2025 15:32:41 -0600 Subject: [PATCH] Create design-qa-considerations.md (#26774) Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com> Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com> Co-authored-by: Sam Pfluger <108141731+Sampfluger88@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/story.md | 6 +- docs/Contributing/design-qa-considerations.md | 119 ++++++++++++++++++ 2 files changed, 122 insertions(+), 3 deletions(-) create mode 100644 docs/Contributing/design-qa-considerations.md diff --git a/.github/ISSUE_TEMPLATE/story.md b/.github/ISSUE_TEMPLATE/story.md index 9421c6c2ad..4a87c825ac 100644 --- a/.github/ISSUE_TEMPLATE/story.md +++ b/.github/ISSUE_TEMPLATE/story.md @@ -71,9 +71,9 @@ What else should contributors [keep in mind](https://fleetdm.com/handbook/compan - Risk description: TODO ### Test plan - + + +> Make sure to go through [the list](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/design-qa-considerations.md) and consider all events that might be related to this story, so we catch edge cases earlier. 1. Step 1 2. Step 2 diff --git a/docs/Contributing/design-qa-considerations.md b/docs/Contributing/design-qa-considerations.md new file mode 100644 index 0000000000..890cca5247 --- /dev/null +++ b/docs/Contributing/design-qa-considerations.md @@ -0,0 +1,119 @@ +# Design / QA considerations + +This is meant to be a helpful checklist of 'events' or 'transactions' to help catch edge cases sooner rather than later while designing or testing new features or bugs. Please feel free to add more if any are missing. + +## User + +- Create user +- Remove user +- Update user permissions +- API-only user + +## Team + +- Create team +- Remove team +- No team +- All teams +- Transfer host into this team +- Transfer host out of this team + +## MDM + +- Turn MDM on +- Turn MDM off +- Enable disk encryption +- Disable disk encryption +- Add ABM token +- Add multiple ABM tokens +- Remove ABM token +- Add VPP token +- Add multiple VPP tokens +- Remove VPP token +- Add minimum version OS updates +- Remove minimum version OS updates +- Add profile +- Remove profile +- Resend profile +- Add bootstrap package +- Remove bootstrap package +- Single host turn MDM off +- Setup experience software / scripts +- SSO enabled for DEP enrollment +- EULA added for DEP enrollment + +## Software + +- Add software to team + - FMA + - VPP + - custom package +- Remove software from team +- Edit software (scripts / binary) +- Add script +- Run script +- Edit script +- Remove script +- Vulnerability scans +- Automatic software install +- Label-scoped software install + +## Policy + +- Add policy +- Remove policy +- Add install automation +- Add Calendar automation + +## Query + +- Add query +- Remove query +- Edit query +- Live query +- Saved query results + +## Labels + +- Add dynamic label +- Remove dynamic label +- Add Manual label +- Remove Manual label +- Add host to an existing label +- Remove a host from a label +- Label selecion (policy / profile / software) + - Include all + - Include any + - Exclude all + - Exclude any + +## Host + +- Enroll to Fleet using Fleet's agent (fleetd) +- Enrolled via osquery (no orbit / fleetd) +- Deleted from Fleet +- DEP enrollment +- BYOD enrollment +- ABM ghost host before enrolled +- Wiped host +- Locked host +- Host that succeeds all policies +- Host with a failing policy +- Online host +- Offline host + +## Integrations + +- Jira +- Zendesk +- Webhooks + +## Config + +- Host callback times other than 1hr +- DB primary / replica +- Async ingestion of policies + + + +