Skip to content
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.

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

Remove dist folder from git #18

Closed
thiamsantos opened this issue Sep 9, 2017 · 2 comments
Closed

Remove dist folder from git #18

thiamsantos opened this issue Sep 9, 2017 · 2 comments

Comments

@thiamsantos
Copy link
Contributor

thiamsantos commented Sep 9, 2017

Remove dist folder from to git as it is a file automatically generated and we don't need to keep track of them. In that way would be possible to keep the pull requests more clean. To accomplish this just add the dist folder to the gitignore file and add a files property to the package.json specifying the files to be included in the package when download it from npm. Right now all the repo is included.

The only problem that I can see on doing this is that the demo uses a relative path to the dist folder. But the demo can pull the project from a cdn (related #17).

@ApoorvSaxena
Copy link
Owner

Remove dist folder from to git as it is a file automatically generated and we don't need to keep track of them.

Removing dist will require folks to implement the build procedure that we've implemented in our project, will seem overkill to new starters, though we can integrate Travis CI to build dist/ folder for us.

add a files property to the package.json specifying the files to be included in the package when download it from npm. Right now all the repo is included.

This should be done, right away.

But the demo can pull the project from a cdn

CDN itself refers to the dist folder minified file.

@thiamsantos
Copy link
Contributor Author

Removing dist will require folks to implement the build procedure that we've implemented in our project.

Actually instead of download the files from github a newbie would download the files from the cdn in the same way. No need to to any build procedure.

https://cdn.jsdelivr.net/npm/lozad/dist/lozad.js
https://cdn.jsdelivr.net/npm/lozad/dist/lozad.min.js

though we can integrate Travis CI to build dist/ folder for us.

The best way to do it is add a prepublish script to package.json that run the build script. So even the dist being ignored by git, npm include it at the package.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants