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

all: when code paths are removed, no longer used or deprecated please use the Go Deprecated notice for more scalable and easier maintenance #16094

Closed
odeke-em opened this issue May 11, 2023 · 1 comment
Labels
Type: Code Hygiene General cleanup and restructuring of code to provide clarity, flexibility, and modularity.

Comments

@odeke-em
Copy link
Collaborator

Summary

There are many times that my team has been tasked with an activity such as an existing performance issue or security audits. Given with how rapidly the cosmos-sdk changes and with still open issues, we need a way to scalably indicate when code is no longer used. The resort is advice to check-in on every issue or feature we work on to see if it is still relevant or not, which isn't great for scalable software development.

Proposal

I propose that if code is no longer used and is intentional deprecated, for example no more use of .GetSignBytes() or certain code paths, that we use Go's standard Deprecated notice style which entails adding the comment:

// Deprecated: <message>

Please see:

And we also need to be proactive about giving notice of changed code and code paths.

/cc @aaronc @elias-orijtech

@julienrbrt julienrbrt added Type: Code Hygiene General cleanup and restructuring of code to provide clarity, flexibility, and modularity. and removed T:feature-request labels May 13, 2023
@tac0turtle
Copy link
Member

closing this as its something we follow already

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Code Hygiene General cleanup and restructuring of code to provide clarity, flexibility, and modularity.
Projects
None yet
Development

No branches or pull requests

3 participants