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.

Sign up for GitHub

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

Jump to bottom

chore: template for new API development #341

Open
chungquantin opened this issue Oct 14, 2024 · 0 comments
Open

chore: template for new API development #341

chungquantin opened this issue Oct 14, 2024 · 0 comments
Labels
api Pop API documentation Improvements or additions to documentation low priority

Comments

@chungquantin
Copy link
Collaborator

chungquantin commented Oct 14, 2024 •
edited
Loading

We should have a template for a new API development. Referencing from the #335 and #65

The template must include:

Overview

  • Description of the API
  • Who should be involved in the development
  • Expected outcome of the API
  • User guide

Low-level design

  • API specification
  • Pallet development + unit testing + benchmarking
  • Pop API library + integration tests
    • New traits? New function selector?
    • New errors?
  • Example contract + testing with pop-drink
@chungquantin chungquantin added low priority api Pop API documentation Improvements or additions to documentation labels Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
api Pop API documentation Improvements or additions to documentation low priority
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@chungquantin