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 automated toolings to rename methods/variables, for instructional aids #174

Open
hayeah opened this issue Dec 13, 2020 · 2 comments
Open

Comments

@hayeah
Copy link

hayeah commented Dec 13, 2020

i know this bike-shed had been fought over many times in past ages... but i've built a little script convert these names to more standard names.

i've made a little script to do it, so even if code updates in the future it'd be easy to convert quickly with a github hook.

https://github.com/hayeah/dss/tree/rename#renaming

To aid new developers, perhaps consider two options:

  1. maintain a branch for the non-quirky naming scheme, or
  2. include the toolings as part of DEVELOPING.md
@brianmcmichael
Copy link
Contributor

MCD is on chain at this point and the core system won't be changing much. You may want to check out https://github.com/alexvansande/MuchClearerDAI for a project that's been working to provide a more accessible version of the codebase.

@hayeah
Copy link
Author

hayeah commented Dec 14, 2020

@brianmcmichael hi Brian, thanks for the reply.

I understand that MCD is on-chain, and it's not feasible to change the deployed names.

However, having a more accessible code as doc would be helpful.

I am also aware of MuchClearerDAI. But:

  1. it's not kept up to date.
  2. it's not automated

For example, we could use a github hook to generate the accessible code, for reference purposes.

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