Skip to content
This repository has been archived by the owner on Nov 1, 2023. It is now read-only.

Generator Feedback #200

Open
sakulstra opened this issue Jul 3, 2023 · 6 comments
Open

Generator Feedback #200

sakulstra opened this issue Jul 3, 2023 · 6 comments
Labels
question Further information is requested

Comments

@sakulstra
Copy link
Collaborator

sakulstra commented Jul 3, 2023

We created a very sparse proposal generator accessible via yarn generate

This ticket only exists to collect initial feedback on if this is useful or not & what features would be required to make it more useful.

  • figure out how to properly add dates
  • more clear flags
  • add prompt for missing flags
  • add _Test and _Payload suffix for easier readability
@sakulstra sakulstra added the question Further information is requested label Jul 3, 2023
@efecarranza
Copy link
Contributor

This is a great tool, really happy for it and excited to use it, it saves a lot of time.

Some things I noticed:

The deployment .s.sol file does not have EthereumScript imported. CreateProposal extends this contract.

The date I'd do as YYYYMMDD rather than YYYYDDMM, I think YYYYMMDD is the standard or at least the most common.

For the -t option, I was expecting it would be the .md file's name, not the title inside of the file.

@efecarranza
Copy link
Contributor

Follow up: Probably makes sense to add _Payload and _Test at the end of the files.

@efecarranza
Copy link
Contributor

In tests, allConfigsAfter still says pre instead of post for the configuration snapshot.
createDiffs() is not added automatically

@sakulstra
Copy link
Collaborator Author

sakulstra commented Jul 11, 2023

@efecarranza make sure you on latest main, the last issue reported should already be fixed as previously reported by @marczeller (b087f26)

The deployment .s.sol file does not have EthereumScript imported. CreateProposal extends this contract.

Ah this happened in the case Ethereum was not a target 😅 - fixed on newest main

@yonikesel
Copy link
Contributor

Hey, excited to use the tool.
Noticed that when creating an AIP for V2, the CLI expects upper-case "V2" while name generator checks for lower-case "v2".
I created a PR for the fix: PR

@sakulstra
Copy link
Collaborator Author

  • generator breaks when there are special characters in the proposal title as it will generate invalid solidity code

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants