[x] Check that the project is active by their repository/issues/PR.
[x] Run cd web && pnpm size, check the JS bundle size changes, about limits if necessary.
[x] Think about testing
If you added a feature, add unit tests.
If you added a new state to the UI, add visual tests.
If you fixed the bug, think about preventing bug regression in the future.
If you changed web client:
[x] Think about moving code to core/. What code will also be useful on other platforms?
[x] Run pnpm size and check the difference in the JS bundle size. Is it relevant to the changes? Change the limit in web/.size-limit.json if necessary.
[x] Think about keyboard UX. Is it easy to use the new feature with only one hand on a keyboard? Is it easy to understand what keys to press?
[x] Think about HTML semantics.
[x] Think about accessibility. Check a11y recommendations. Think about how screen reader users will use the tool. Is it easy to use on a screen with bad contrast?
[x] Think about translations. Will
[x] Think about right-to-left languages. What parts of the screen should be mirrored for Arabic or Hebrew languages?
If you changed the colors token in the web client:
[x] Think about app loading styles inlined in index.html.
If you changed core/:
[x] Think about making types more precise. Can you better explain data relations by type?
[x] Think about conflict resolution. We don’t need some very smart changing merging; just 2 changes of the same item on different clients should not break the database. What if the user changes an item on one machine and removes it on another?
[x] Think about log and storage migration.
If you changed English translations:
[x] Change translation ID if you change the meaning of the text.
Thanks!
Thanks for the project and for the inspiring vision of local first web!
Fixes # (No issue)
I changed
Where Ask Question
toWhere to Ask Questions
inCONTRIBUTING.md
fileMotivation
Hi! I'm sorry to nitpick, but
where to ask questions
is not really grammatically correct..Checklist
scripts/
, add a comment with a description.README.md
.README.md
.node_modules
size, and subdependencies number.cd web && pnpm size
, check the JS bundle size changes, about limits if necessary.core/
. What code will also be useful on other platforms?pnpm size
and check the difference in the JS bundle size. Is it relevant to the changes? Change the limit inweb/.size-limit.json
if necessary.index.html
.core/
:Thanks!
Thanks for the project and for the inspiring vision of local first web!