Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Danger pattern guidance #113

Draft
wants to merge 17 commits into
base: main
Choose a base branch
from
Draft

Danger pattern guidance #113

Changes from 5 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
493a35c
beginning draft spec for save models. expecting to iterate on this co…
Jul 13, 2020
5685082
conflict
Jul 13, 2020
ee59bdc
first pass on rough draft of danger requirements
Jul 28, 2020
754caf1
updates language for some details based on crit earlier today as well…
Jul 29, 2020
1734ecc
adds link to logging documentation
Jul 31, 2020
fbc19e8
Copy edits
yaili Aug 3, 2020
331430e
adds detail, addresses feedback, adjusts lists to support images
Aug 4, 2020
dc965bc
merge conflicts
Aug 4, 2020
cfef9c1
images not working quite yet, but the content is in a place where I'm…
Aug 5, 2020
655004d
changing import statement
Aug 5, 2020
3d964a0
changing image references again
Aug 5, 2020
196b389
removes githubber reference
Aug 5, 2020
a147ef6
Copyedits
yaili Aug 6, 2020
dfdf3dd
adds links and cleans up copy
Aug 6, 2020
d0d1dd5
merge conflicts
Aug 6, 2020
1d627b2
updates images and image refs
Aug 7, 2020
923a383
Copy edits
yaili Jan 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions content/ui-patterns/danger.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Destructive (danger) sequences
---

When users are making a destructive change to their GitHub account, we need to make sure they have a clear understanding of what is about to happen. Many times these changes are reversible, but may have irreversible side effects (making a repository public). Other times, they're not reversible at all (deleting an organization). Either way, we need to ensure that we've done everything we can to make sure there are no gaps in communication that may cause unintended effects so that we don't lose trust with users.

There are a couple types of data that will need to be modified through our UI. Some of these types are not critical and require no particularly special treatment. These non-critical destructive flows include deleting a comment, issue, pull request, or discussion.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some notes here:

  • Could be: "There are some types of data" (instead of "a couple")
  • I'm not sure I follow the first sentence though. Would it be easier to determine that this paragraph deals with non-critical destructive flows, and the follow paragraph deals with critical destructive flows if the order of sentences were reversed: "Non-critical destructive flows include deleting a comment, issue, pull request, or discussion. These types of data need to be modified through the UI [still not sure what this means exactly], most aren't critical and require no special treatment."

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah - initially, that was going to lead directly into: "critical and non-critical", which is where "a couple" came from.

I'll fix that. Thanks Yaili!


For critical destructive flows (including modifying user access, deleting repositories, making private data public, etc.), there are 3 basic treatments we can apply that will ensure that the full effects of a change are clear to our users and that we minimize loss of trust.

[Example image 1 goes here]()

1. We should highlight all destructive flows visually.
- Any actions that will delete significant user data must use the `btn-danger` class.
- All page sections that will trigger a destructive sequences should be highlighted with `border-red` and an `alert` icon to build an accessible, intuitive pattern of recognition. When people see those details, they should know to tread carefully. Ideally, these will be centralized into a `Danger Zone` section.

[Example image 2 goes here]()

2. We should force users into a second confirmation to ensure that they understand which data will be destroyed, the steps to revert those changes (if reversible), and that they have rights to destroy that data with an explicit statement, and/or password-protection.

[Example code goes here]

3. We should follow the [audit logging rules](https://githubber.com/article/technology/dotcom/audit-logs/adding-new-events) and log all destruction events for the support team to help them with cases where something has gone wrong.