Skip to content

Commit 6dbe1ed

Browse files
committed
[guide] Non-code issues: keep them out of your code files.
1 parent 685f37b commit 6dbe1ed

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3609,6 +3609,29 @@ Other Style Guides
36093609

36103610
**[⬆ back to top](#table-of-contents)**
36113611

3612+
## Non-code issues
3613+
3614+
Now that your code is covered, consider some aspects that are not/
3615+
should not be about *your* code:
3616+
3617+
<a name="non-code-issues--transport-and-packaging"></a><a name="31.1"></a>
3618+
- [31.1](#non-code-issues--transport-and-packaging)
3619+
**Transport and packaging**:
3620+
Your code should not be concerned with how it's going to be packaged
3621+
or transported. Caring about those aspects should be left to automated
3622+
tools that are part of your build stack.
3623+
- All of your code files should use Unicode in UTF-8 encoding.
3624+
- Since all of them do, mentioning it inside your code files
3625+
(e.g. via a BOM (Byte Order Mark)) is useless noise.
3626+
Instead, configure your tools so they know UTF-8 is your default.
3627+
eslint: [`unicode-bom`](https://eslint.org/docs/rules/unicode-bom.html)
3628+
- Don't re-invent import/export compatibility mechanisms.
3629+
If you need support for CommonJS or AMD or UMD, just tell your
3630+
transpiler or bundler. Let other people care about optimizing
3631+
that wrapping and dealing with its edge cases.
3632+
3633+
**[⬆ back to top](#table-of-contents)**
3634+
36123635
## Performance
36133636

36143637
- [On Layout & Web Performance](https://www.kellegous.com/j/2013/01/26/layout-performance/)

0 commit comments

Comments
 (0)