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 more details about project in README #77

Merged
merged 17 commits into from
Apr 15, 2022
Merged

Add more details about project in README #77

merged 17 commits into from
Apr 15, 2022

Conversation

pscott
Copy link
Contributor

@pscott pscott commented Apr 10, 2022

This PR adds details in the README, mainly by giving an overview of the flow and the different modules of Snapshot X.
It also renames voting_period to voting_duration which better represents the variable.

@pscott pscott marked this pull request as ready for review April 10, 2022 13:42
@bonustrack
Copy link
Member

How "duration" is better than "period"? I've used period cuz its how it's called on Compound governor, I'd prefer if we follow same naming.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
* Update README.md

* Update README.md

* Add files via upload

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Add files via upload

* Update README.md

* Update README.md

* Update README.md

* Update README.md
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@pscott
Copy link
Contributor Author

pscott commented Apr 14, 2022

How "duration" is better than "period"? I've used period cuz its how it's called on Compound governor, I'd prefer if we follow same naming.

When we talked about it on Discord the other day we all agreed that duration made more sense than period. The only reason we'd keep period would be to "follow the compound standard" but since we're building some different tools, I'm not sure we should stick to their naming IF we find a better naming solution :) wdyt?

README.md Outdated Show resolved Hide resolved
@Orland0x
Copy link
Contributor

Orland0x commented Apr 14, 2022

How "duration" is better than "period"? I've used period cuz its how it's called on Compound governor, I'd prefer if we follow same naming.

When we talked about it on Discord the other day we all agreed that duration made more sense than period. The only reason we'd keep period would be to "follow the compound standard" but since we're building some different tools, I'm not sure we should stick to their naming IF we find a better naming solution :) wdyt?

yeah i agree that keeping to a convention isnt that important here, not too bothered either way though

@Orland0x Orland0x closed this Apr 14, 2022
@Orland0x Orland0x reopened this Apr 14, 2022
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@pscott pscott merged commit 3dff6b5 into develop Apr 15, 2022
@Orland0x Orland0x deleted the update_readme branch May 4, 2022 13:34
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.

3 participants