Skip to content

Commit 0bc58d1

Browse files
committed
[guide] Non-code issues: keep them out of your code files.
1 parent 8cf2c70 commit 0bc58d1

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
@@ -3363,6 +3363,29 @@ Other Style Guides
33633363
33643364
**[⬆ back to top](#table-of-contents)**
33653365
3366+
## Non-code issues
3367+
3368+
Now that your code is covered, consider some aspects that are not/
3369+
should not be about *your* code:
3370+
3371+
<a name="non-code-issues--transport-and-packaging"></a><a name="31.1"></a>
3372+
- [31.1](#non-code-issues--transport-and-packaging)
3373+
**Transport and packaging**:
3374+
Your code should not be concerned with how it's gonna be packaged or
3375+
transported. Caring about those aspects should be left to automated
3376+
tools that are part of your build stack.
3377+
- All of your code files should use Unicode in UTF-8 encoding.
3378+
- Since all of them do, mentioning it inside your code files
3379+
(e.g. via a BOM (Byte Order Mark)) is useless noise.
3380+
Instead, configure your tools so they know UTF-8 is your default.
3381+
eslint: [`unicode-bom`](https://eslint.org/docs/rules/unicode-bom.html)
3382+
- Don't re-invent import/export compatibility mechanisms.
3383+
If you need support for CommonJS or AMD or UMD, just tell your
3384+
transpiler or bundler. Let other people care about optimizing
3385+
that wrapping and dealing with its edge cases.
3386+
3387+
**[⬆ back to top](#table-of-contents)**
3388+
33663389
## Performance
33673390
33683391
- [On Layout & Web Performance](https://www.kellegous.com/j/2013/01/26/layout-performance/)

0 commit comments

Comments
 (0)