search

Developer-DAO / create-dao

MIT License
93 stars 15 forks source link

adding lerna #28

Closed e-roy closed 2 years ago

e-roy commented 2 years ago

This will add lerna for easier publishing to npm. This creates a massive change in the file structure of the project

e-roy commented 2 years ago

Should be linked to this issue:

https://github.com/Developer-DAO/create-dao/issues/20

e-roy commented 2 years ago

@with-heart I just noticed the .bin files in my PR. Should I delete them?

Dhaiwat10 commented 2 years ago

@with-heart I just noticed the .bin files in my PR. Should I delete them?

I think you should

with-heart commented 2 years ago

I promise I will review this today! I'm sorry it is taking so long

e-roy commented 2 years ago

I will be happy to remove the docs folder. I will also be happy to use another solution than implementing lerna if desired.

It seemed this project was inspired by create-next-app as from the discussion here

I noticed by going with a wrapper design it created this issue here

So I started to reverse engineer how CNA did it and arrived to this solution here

Which created this issue here

To solve it with workspaces here

Which this lead to this issue here

To resolve with the solution in this current PR

I created the docs folder because of discussions from our discord for having better documentation, also from @Dhaiwat10 comment in this thread that there was a need to elaborate further on scripts.
Inside the README.md there are links that referenced these doc files for further context for contributors to find everything in one organized place.

All of which are inspired from CNA's design, making the assumption from their product's success, was something worth modeling from to create a scalable product.

I also assumed that since this product was still far from an MVP that large rapid changes in the beginning would get to product market fit faster for further development, and I apologize for that assumption also.

I will happily implement smaller changes with more discussions if that is what is desired.

Please advise on whether I should continue with lerna, or implement another design for this project, and also the removal of the docs folder. I’m looking forward to helping and contributing to the community :)

Dhaiwat10 commented 2 years ago

@e-roy I think we're good!

with-heart commented 2 years ago

Ye, definitely good to go!

Had been working on a reply but hadn't finished it yet. Wanted to go ahead and post it anyway :)

I don't think you really have anything to apologize for! Like I said before, we can definitely move forward with what you have, just wanted to share some context about how I tend to think about things.

Your reasoning makes perfect sense and I appreciate you taking the time to provide the past context that lead you to this PR! ❤️

All of which are inspired from CNA's design, making the assumption from their product's success, was something worth modeling from to create a scalable product.

For sure! I think that's a good point and is a logical assumption to make. I think it's something worth modeling as we mature and scale as a product, but as it is right now, this is a much smaller project with a much less experienced team building it, so it's good to build our processes with that in mind too!

The docs folder really isn't as big of a deal as some of my comments may have made it out to be and I'm sorry for that! My thinking was that with such a small team and lots of potentially newbie contributors, the less we spread information out the easier it is to find that information. But a few extra files is not a problem, especially since you linked them from README.md!

I also assumed that since this product was still far from an MVP that large rapid changes in the beginning would get to product market fit faster for further development, and I apologize for that assumption also.

I will happily implement smaller changes with more discussions if that is what is desired.

I think that's a good assumption to make and I'm definitely in favor of focusing on action and moving fast over spending too much time on process/discussion.

At the same time, balance is usually a good thing and I think the more we can break things down, the easier it is to have more targeted discussions, more flexible outcomes, and better historical documentation of what we're doing, why we're doing it, and how we did it!

imo it's less of a hard requirement in my view and more like "where convenient, prefer to break things down". Sometimes it's convenient, sometimes it isn't. We'll work through it either way :)