[TODO] Document why build files are committed and/or decide if this is still necessary
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 5
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
The current reason why build files are committed is because of legacy / browser support. That is, the browser build is committed to the root dist folder, which can be used as-is in browsers.
The reason why there are TWO dist folders, and it's copied to both is because of the monorepo setup. When it was moved to the appropriate package folder, it broke documented links for CDNs which convert a Github repo's file structure into URLs.
Similarly, because of these CDN links, the root package.json has a version number, even though many monorepos do not version the root package.json.
It's possible that this setup is no longer necessary. Ideally, build files would no longer be committed (but would be published), but some research would be needed (with information / evidence here) to say if that's safe to change / remove.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the committed build files in the root dist folder and the second dist folder in the monorepo, along with the root package.json. Research whether the documented CDN links still depend on this layout and version, then record evidence supporting either keeping the files or safely removing them and publishing instead.
Written by the indexing model from the issue text.
Assessment
- Domain
- build-system, release
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100