Skip to content

Commit be07e51

Browse files
committed
[guide] Non-code issues: keep them out of your code files.
1 parent c8b1164 commit be07e51

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
@@ -3407,6 +3407,29 @@ Other Style Guides
34073407
34083408
**[⬆ back to top](#table-of-contents)**
34093409
3410+
## Non-code issues
3411+
3412+
Now that your code is covered, consider some aspects that are not/
3413+
should not be about *your* code:
3414+
3415+
<a name="non-code-issues--transport-and-packaging"></a><a name="31.1"></a>
3416+
- [31.1](#non-code-issues--transport-and-packaging)
3417+
**Transport and packaging**:
3418+
Your code should not be concerned with how it's gonna be packaged or
3419+
transported. Caring about those aspects should be left to automated
3420+
tools that are part of your build stack.
3421+
- All of your code files should use Unicode in UTF-8 encoding.
3422+
- Since all of them do, mentioning it inside your code files
3423+
(e.g. via a BOM (Byte Order Mark)) is useless noise.
3424+
Instead, configure your tools so they know UTF-8 is your default.
3425+
eslint: [`unicode-bom`](https://eslint.org/docs/rules/unicode-bom.html)
3426+
- Don't re-invent import/export compatibility mechanisms.
3427+
If you need support for CommonJS or AMD or UMD, just tell your
3428+
transpiler or bundler. Let other people care about optimizing
3429+
that wrapping and dealing with its edge cases.
3430+
3431+
**[⬆ back to top](#table-of-contents)**
3432+
34103433
## Performance
34113434
34123435
- [On Layout & Web Performance](https://www.kellegous.com/j/2013/01/26/layout-performance/)

0 commit comments

Comments
 (0)