Skip to content

Latest commit

 

History

History
17 lines (13 loc) · 904 Bytes

contributing.md

File metadata and controls

17 lines (13 loc) · 904 Bytes

Contributing

This isn't really a guide yet, more an outline on how I am currently developing the project. If you do want to contribute, please contact me.

Adding new functionality to the wrapper

Here is a very rough overview of the steps I take to add a new feature:

  1. Outline what the feature should do and where in the code it will fit (Can it be added to an existing class, or does it need its own class?)
  2. Go through the actions in the Storytel mobile app, and inspect the network traffic with mitmproxy.
  3. Write code to copy the request(s) needed for the feature
  4. If needed, add types for the response
  5. Write tests to accompany the new feature
    This is after programming, because usually it is unclear what the exact functionality of an API endpoint is during development.