dss icon indicating copy to clipboard operation
dss copied to clipboard

add automated toolings to rename methods/variables, for instructional aids

Open hayeah opened this issue 4 years ago • 2 comments

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

hayeah avatar Dec 13 '20 11:12 hayeah

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.

brianmcmichael avatar Dec 13 '20 16:12 brianmcmichael

@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.

hayeah avatar Dec 14 '20 02:12 hayeah