Skip to content

docs: how we manage shipped files #1296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 12, 2025
Merged

docs: how we manage shipped files #1296

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44514ab
docs: dev shipped files
jkowalleck Sep 12, 2025
00d91ba
docs
jkowalleck Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/dev/shipped-files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Shipped files

Of cause, we ship the build results (JavaScript and type definitions).

We also ship our sources (TypeScript), so that downstream users can work with them directly with own compilers/builders/packers.
And we ship all the build instructions we used.
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>)
We manage our shipped files in a [`.npmignore`](../../.npmignore) file.
Loading