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

Disallow the word "Smart" in the titles (and descriptions) of EIPs #5308

Closed
Pandapip1 opened this issue Jul 22, 2022 · 4 comments
Closed

Disallow the word "Smart" in the titles (and descriptions) of EIPs #5308

Pandapip1 opened this issue Jul 22, 2022 · 4 comments

Comments

@Pandapip1
Copy link
Member

Like #5009 but with the word "smart" instead.

@SamWilsn
Copy link
Contributor

SamWilsn commented Jul 22, 2022

I can't thumb up this enough.


Edit: maybe we should allow smart, but only as part of "smart contract"?

@Pandapip1
Copy link
Member Author

maybe we should allow smart, but only as part of "smart contract"?

I think that it's unambiguous enough to just use "contract." If you're talking about any (proto-)EIP other than #5289, there's only one possible interpretation.

@Pandapip1 Pandapip1 changed the title Disallow the word "Smart" in the title of EIPs Disallow the word "Smart" in the titles (and descriptions) of EIPs Jul 22, 2022
@xinbenlv
Copy link
Contributor

xinbenlv commented Jul 25, 2022

As much as I appreciate the intention to make description more readable, I object to this editorial rule. I think it shall be author to decide the name. I don't think editor group already have or shall have the power to make such judgement.

@MicahZoltu
Copy link
Contributor

As much as I appreciate the intention to make description more readable, I object to this editorial rule. I think it shall be author to decide the name. I don't think editor group already have or shall have the power to make such judgement.

I believe the problem here is that 99% of ERCs are just contract interface definitions, and people have a tendency to not realize the amount of redundancy they are including in their title when they say "X Smart Contract Standard". The entire latter portion of that sentence is almost entirely redundant and if we say nothing we can end up in a situation where every single ERC is named following that pattern or a very similar one.

As editors, we have a better overall grasp of the EIP ecosystem and recognize the redundancy where drive-by authors may not.

FWIW: The text added for discouraging the word "Standard" in titles wasn't a hard requirement, it was just a SHOULD NOT so there is leeway for exceptions. In the vast, vast, majority of cases in my experience though, the authors are just unwittingly using "standard" and "smart" redundantly.

@Pandapip1 Pandapip1 closed this as not planned Won't fix, can't repro, duplicate, stale Aug 5, 2022
This issue was closed.
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 a pull request may close this issue.

5 participants
@xinbenlv @MicahZoltu @Pandapip1 @SamWilsn and others