Add a Best Practices section to the website. NFC - #27334
Open
sbc100 wants to merge 4 commits into
Open
Conversation
sbc100
force-pushed
the
best_practices
branch
3 times, most recently
from
July 13, 2026 20:30
7d2220d to
7052085
Compare
kripken
reviewed
Jul 13, 2026
kripken
reviewed
Jul 13, 2026
kripken
reviewed
Jul 13, 2026
kripken
reviewed
Jul 13, 2026
kripken
reviewed
Jul 13, 2026
kripken
reviewed
Jul 13, 2026
kripken
reviewed
Jul 13, 2026
kripken
reviewed
Jul 13, 2026
kripken
reviewed
Jul 13, 2026
kripken
reviewed
Jul 13, 2026
sbc100
force-pushed
the
best_practices
branch
3 times, most recently
from
July 14, 2026 18:35
f9da982 to
407b7ab
Compare
dschuff
reviewed
Jul 15, 2026
dschuff
left a comment
dschuff
left a comment
Member
There was a problem hiding this comment.
oops, I forgot to hit send yesterday.
kripken
reviewed
Jul 15, 2026
sbc100
commented
Jul 16, 2026
sbc100
left a comment
sbc100
left a comment
Collaborator
Author
There was a problem hiding this comment.
Feedback addressed
kripken
reviewed
Jul 17, 2026
hoodmane
reviewed
Aug 11, 2026
sbc100
force-pushed
the
best_practices
branch
2 times, most recently
from
August 25, 2026 19:44
a282780 to
b759f99
Compare
kripken
reviewed
Aug 26, 2026
kripken
reviewed
Aug 26, 2026
kripken
reviewed
Aug 26, 2026
| - **Don't include the "=1" suffix for boolean flags.** For example, write | ||
| ``-sSTRICT`` and ``-sALLOW_MEMORY_GROWTH`` rather than ``-sSTRICT=1`` or | ||
| ``-sALLOW_MEMORY_GROWTH=1``. | ||
| - **Use separate compilation** by compiling ``.cpp`` sources to ``.o`` object |
Member
There was a problem hiding this comment.
I would put all the things before this in a "lint" section. Separate compilation and C++/JS interop feel like substantially different things, choices about the build system and design.
Collaborator
Author
There was a problem hiding this comment.
I've called this section "Command-Line Style" .. I also considered "Command line hygene"
kripken
reviewed
Aug 26, 2026
kripken
reviewed
Aug 26, 2026
kripken
reviewed
Aug 26, 2026
kripken
reviewed
Aug 26, 2026
kripken
reviewed
Aug 26, 2026
| - For small temporary files, ``MEMFS`` is sufficient. | ||
| - For persistent client-side data storage across browser sessions, use | ||
| asynchronous storage backends such as :ref:`filesystem-api-idbfs` or the | ||
| :ref:`Filesystem-API`. |
Member
There was a problem hiding this comment.
Perhaps just link to the main filesystem page for filesystem recommendations? This could also summarize that page, if we want that (if so, perhaps mention WasmFS).
Collaborator
Author
There was a problem hiding this comment.
Yes, that makes sense. Linked to wider docs on FS
Collaborator
Author
There was a problem hiding this comment.
I removed this section for now
dschuff
approved these changes
Aug 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I've been working on this as part of the https://developer.chrome.com/docs/modern-web-guidance project and it seems like whatever we do there it makes sense to maintain best practices guide directly in emscripten.