Skip to content

Commit d1ccd7e

Browse files
committed
doc: Add section on UI design and matching Figma
1 parent 154c873 commit d1ccd7e

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,32 @@ See [upstream docs on `flutter test`][flutter-cookbook-unit-tests].
172172

173173
## Notes
174174

175+
### UI design
176+
177+
For issues that call for building new UI, we typically have a
178+
design in Figma which will be linked from the issue description.
179+
180+
When there is a design in Figma, a PR implementing the issue
181+
should match the design exactly, except where there's a
182+
good reason to make things different.
183+
Like with any difference between a PR and previous plans,
184+
you should [explain the difference](https://zulip.readthedocs.io/en/latest/contributing/reviewable-prs.html#explain-your-changes)
185+
clearly in your PR description.
186+
187+
For colors, padding, font sizes, and similar design details,
188+
it's rare to have a good reason to differ from the
189+
design in Figma.
190+
When [reviewing your work](https://zulip.readthedocs.io/en/latest/contributing/reviewable-prs.html#review-your-own-work)
191+
(which you should do before every PR),
192+
take some time to look closely through all the details of
193+
the design in Figma
194+
and confirm that they're matched in your PR.
195+
196+
In our code, many colors and other details appear on `DesignVariables`
197+
or similar classes like `ContentTheme`. If you need a Figma variable
198+
which doesn't yet appear in our code, please add it.
199+
200+
175201
### Writing tests
176202

177203
We write tests for all changes to the Dart code in the app.

0 commit comments

Comments
 (0)