Skip to content

Commit

Permalink
Clarified design sections.
Browse files Browse the repository at this point in the history
  • Loading branch information
amyjko committed Mar 7, 2024
1 parent 82239ff commit bcdb547
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,10 @@ Smartphone
- Browser + version [e.g. Safari]

If you're not reporting an issue on the production site, also describe the environment you are running in (vite dev server, vite build, whether the Firebase emulator is running, whether you're authenticated using the emulator and how.)

## Design specification

If this defect requires some redesign, include a design proposal here (and if you don't have one, add the `needs design` label, and you can just write TBD here).
Design proposals should describe, in precise detail _what_ the proposed design is, but not necessarily how it might be built. Note that the design proposal for a defect should align with the expected behavior you described above.

Once the design is approved, we will add the `buildable` tag is added.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ What do you propose to change or add to address the problem above? Describe some

## Design specification

(This section should be included after a design proposal is ready and approved, and the `buildable` tag is added. This text can remain until then. Designers should add their proposal here, not in a comment).
_Reporters can leave this blank. Designers should write a detailed, precise description of what is to be built. If images are necessary to convey this precisely, make sure to include image descriptions, so everyone can see what is in the image. Do not link to external documents; everything should be embedded here. Once the design is approved, we will remove the `needs design` tag and replace it with the `buildable` tag, signalling that it can be built._

0 comments on commit bcdb547

Please sign in to comment.