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

Add Buidler to list of dev tools in build section. #42

Merged
merged 3 commits into from
May 13, 2019

Conversation

fzeoli
Copy link
Contributor

@fzeoli fzeoli commented May 1, 2019

No description provided.

@jjmstark jjmstark requested a review from maurelian May 9, 2019 16:09
@maurelian
Copy link
Contributor

Happy to include buidler, but please make the formatting consistent with the rest of the listings.

image

### Buidler *A task runner for Ethereum smart contract developers*
- [buidler.dev](https://buidler.dev)
- [Github](https://github.com/nomiclabs/buidler)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lines 67 to 71 should be moved above line 64, or is Buidler not a developer tool?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is, and the way I see it this is the structure I proposed:

Developer tools
    Frameworks
        Truffle
        Embark
        Waffle

    Workflow automation
        Buidler

Buidler is a task runner, not a development or testing framework, so I added a new category under Developer tools, same hierarchy level as Frameworks. I wasn't sure where else to put it.

What do you suggest?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right. Actually the issue is that the Frameworks formatting is wrong.
image

IMO 'frameworks' which is probably one of the vaguest words in all of software should just be removed, and Buidler inserted under Developer tools so that we have:

Developer tools
        Truffle
        Embark
        Waffle
        Buidler

What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree 100% about "frameworks", but I think the original intention was to have "Developer tools" as the top level category for all the developer tools, and then have more detailed categories inside. Maybe we could repeat the tools across several categories to communicate more precisely what they're good for? like

Developer tools
    Testing libraries
        Waffle
        Truffle
        Embark
    Dapp development
        Embark
    Workflow automation
        Buidler
    Deployment
        Etherlime
        Truffle
        Embark
        Buidler
     Linters
          Solhint

I know that with the huge amount of features some of these tools have they'll be repeated a lot, but while redundant this feels like much better orientation for someone who's never used any of them.

What do you think? I'm also not against doing just one list without categories but I don't think that will last very long as all the dev tools are added

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At this point, I don't want to list things multiple times, or worry about how to design for another level of headings.

Going with the simplest solution for now.

@fzeoli
Copy link
Contributor Author

fzeoli commented May 10, 2019

Happy to include buidler, but please make the formatting consistent with the rest of the listings.

image

I think it is the same format as the other listings. Workflow automation is formatted the same as Frameworks, and the Buidler line is the same as the other tools. Maybe the Workflow automation bit was confusing out of context? or am I missing something?

image

@maurelian maurelian merged commit 6e524e5 into ethereum:master May 13, 2019
PeersHut added a commit to PeersHut/ethereum-org-website that referenced this pull request May 30, 2021
Changed * into &ethereum#42; because * is not visible on webpage
TylerAPfledderer pushed a commit to TylerAPfledderer/ethereum-org-website that referenced this pull request Oct 27, 2023
updated interface using optional lastUpdatedDate, but this should be hardened in the Front matter schema PR ethereum#42
TylerAPfledderer pushed a commit to TylerAPfledderer/ethereum-org-website that referenced this pull request Oct 27, 2023
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

Successfully merging this pull request may close these issues.

2 participants