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

Build the repo for the new module #3

Open
Martimiz opened this issue Nov 3, 2017 · 2 comments
Open

Build the repo for the new module #3

Martimiz opened this issue Nov 3, 2017 · 2 comments

Comments

@Martimiz
Copy link

Martimiz commented Nov 3, 2017

Hi,
Maybe document a few extra comments on how to build a brandnew repo for the newly created module? Because it basically still starts out as your repo :-)

Here's how I did it - might not be the best way, so please have a look, comments are welcome.

I started by creating an empty repo on Github

  1. adapted Licence and Readme
  2. uncommented node_modules and mapfiles in .gitignore
  3. removed setup.php and setup.json (and yarn.lock :))
  4. removed .git
  5. did a git init
  6. git remote add origin https://github.com/Martimiz/my-repo
  7. did the initial commit
  8. pushed to origin/master

If you agree I will gladly make a pulll

Martine

@colintucker
Copy link
Member

Thanks, I could probably expand upon the docs for that next step. A comment on your build:

uncommented node_modules and mapfiles in .gitignore

You really, really should not do this. node_modules contains the build dependencies only and is often a huge folder, ~60MB or so. This is the point of having the yarn.lock file, so that anyone can download your repo and install the dependencies themselves if they need to. Never commit your node_modules to the repo.

@Martimiz
Copy link
Author

Martimiz commented Nov 4, 2017

Hi,
Thanks for the warning, I was aware of that, but I just mistakenly took the /**/ for comments, being stupid and all, sorry :(

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

No branches or pull requests

2 participants