[SDK] Consider renaming `shannon-sdk` to `pokt-sdk` - Githubissues

pokt-network / poktroll

The official Shannon upgrade implementation of the Pocket Network Protocol implemented using Rollkit.dev

MIT License

15 stars 6 forks source link

[SDK] Consider renaming `shannon-sdk` to `pokt-sdk` #573

Open Olshansk opened 4 weeks ago

Olshansk commented 4 weeks ago

Objective

Align on the best name for the first SDK

Origin Document

https://discord.com/channels/824324475256438814/997192534168182905/1247115603861438536

Screenshot 2024-06-03 at 10 08 28 AM

Goals

Create a good, clear, self-explanatory, non-confusing development experience for pocket network developers who use the SDK

Deliverables

[ ] Determine the best time to have this discussion
[ ] Determine the best name for https://github.com/pokt-network/shannon-sdk
If there is no change -> NOOP
If there is a change
[ ] Update

Non-goals / Non-deliverables

Any business logic changes in the SDK

General deliverables

[ ] Comments: Add/update TODOs and comments alongside the source code so it is easier to follow.
[ ] Testing: Add new tests (unit and/or E2E) to the test suite.
[ ] Makefile: Add new targets to the Makefile to make the new functionality easier to use.
[ ] Documentation: Update architectural or development READMEs; use mermaid diagrams where appropriate.

Creator: @Olshansk Co-Owners: @studna @red-0ne