Skip to content

Commit d849461

Browse files
authored
docs: how we manage shipped files (#1296)
Signed-off-by: Jan Kowalleck <[email protected]>
1 parent 74c6e7c commit d849461

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/dev/shipped-files.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Shipped files
2+
3+
Of cause, we ship the build results (JavaScript and type definitions).
4+
5+
We also ship our sources (TypeScript), so that downstream users can work with them directly with own compilers/builders/packers.
6+
And we ship all the build instructions we used.
7+
Background: our source code requires some special TypeScript compiler options; downstream users might need our special build options, when they work with our shipped sources. (see also: <https://blog.npmjs.org/post/165769683050/publishing-what-you-mean-to-publish.html>)
8+
We manage our shipped files in a [`.npmignore`](../../.npmignore) file.

0 commit comments

Comments
 (0)