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

Package renaming #85

Closed
encody opened this issue Oct 18, 2022 · 2 comments · Fixed by #109
Closed

Package renaming #85

encody opened this issue Oct 18, 2022 · 2 comments · Fixed by #109
Labels
breaking change Fixing this issue will require a breaking change to the API documentation Improvements or additions to documentation enhancement New feature or request

Comments

@encody
Copy link
Member

encody commented Oct 18, 2022

This issue is resolved when all of the below point are resolved or moot:

  • Should the name of the package be changed?
  • To what should the name of the package be changed?
  • All internal references/mentions have been updated, the repository has been moved, the old package has been deprecated on crates.io, and the renamed package has been published to crates.io.
@encody encody added documentation Improvements or additions to documentation enhancement New feature or request breaking change Fixing this issue will require a breaking change to the API labels Oct 18, 2022
@twitu
Copy link
Collaborator

twitu commented Oct 26, 2022

I believe near-contract-tools is the right name for this crate and it doesn't need to change. This crate provides helper functions and macros, essentially tools to enhance the functionality of a contract. In that sense the name is fitting.

That being said if I were propose a name change it would be one of the following

name comment
near-contract-patterns Better option. Indicates exactly how what it offers to someone building a near contract. But may not fit, in case the scope of this crate grows to include more than patterns
near-contract-helpers Good option. But indicates that it helps writing contracts by abstracting complex syntax and does not necessarily add new functionality
near-contract-macros/near-contract-derive Ok option. Generic name that describes what the crate contains but not how it helps the user. It's probably more suited when the expected user is building rust applications or libraries

helpers, derive, macros suffix are commonly used in the rust ecosystem but they tend to indicate general purpose use. This crate is specific to tools for near contracts so it doesn't need to follow this convention.

Secondly I think user generally find helper/complimentary crates through the documentation/readme/blogs. Having this crate linked prominently in a few places will ensure users can find it irrespective of name.

@encody
Copy link
Member Author

encody commented Dec 16, 2022

After some internal consultation, we've decided that the name change that will cause the least confusion and is still the most true to the package is near-sdk-contract-tools.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change Fixing this issue will require a breaking change to the API documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants