Skip to content
This repository has been archived by the owner on Nov 20, 2022. It is now read-only.

Design & implement Datagram public API v1 #19

Open
1 of 2 tasks
mjp0 opened this issue Feb 5, 2019 · 1 comment
Open
1 of 2 tasks

Design & implement Datagram public API v1 #19

mjp0 opened this issue Feb 5, 2019 · 1 comment
Assignees
Labels
task This simply needs to get done
Milestone

Comments

@mjp0
Copy link
Owner

mjp0 commented Feb 5, 2019

Public API is something that can make or break any technical project. I have picked few guiding principles for the design:

  • Intuitive and "familiar" to use
  • Ask as little as possible
  • Do as much as possible

I hope that the above will create an API that doesn't require reading an O'Reilly book to be usable.


Deliverables

  • Documented API design with arguments and explanations
  • Implementation of the designed API
@mjp0 mjp0 self-assigned this Feb 5, 2019
@mjp0 mjp0 added this to the 1.0 milestone Feb 7, 2019
@mjp0
Copy link
Owner Author

mjp0 commented Feb 7, 2019

I've completed the basic outline of the API. It still lacks documented arguments and explanations. I'm going to keep this active but freeze it until I have completed the first implementation. Implementation can many times bring out technical or workflow issues you don't see while designing.

@mjp0 mjp0 added 201910 and removed 201910 labels Mar 4, 2019
@mjp0 mjp0 added 201912 and removed 201911 labels Mar 18, 2019
@mjp0 mjp0 added task This simply needs to get done and removed 201912 labels Mar 27, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
task This simply needs to get done
Projects
None yet
Development

No branches or pull requests

1 participant