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

Create Developer Guide for implementing Test Interface #12

Open
lukehesluke opened this issue Jan 25, 2022 · 1 comment
Open

Create Developer Guide for implementing Test Interface #12

lukehesluke opened this issue Jan 25, 2022 · 1 comment

Comments

@lukehesluke
Copy link
Contributor

lukehesluke commented Jan 25, 2022

The Developer Guide for running Test Suite is pretty good!

It would be good to have something at this level for implementing the Test Interface. So far, implementers have had Test Interface personally explained to them in order to get them to the point where they can implement.

The Test Suite guide is particularly good because it encourages the reader to interact with the system from the very beginning, strengthening their understanding of it. And it is a step-by-step guide, with checkpoints to test that things are working as expected. As a suggestion, this would be a useful guideline to follow where possible.

Issues in understanding that I've seen from helping an implementer implement the Test Suite:

  • After calling the Create Opportunity endpoint, knowing that the newly created Opportunity (and its parent Opportunity) MUST be added to the end of their Opportunity feeds otherwise the tests will not pass.
    • While this is clear once you know how Broker Microservice works and how RPDE works, it would be useful to state it clearly here.
@lukehesluke
Copy link
Contributor Author

A Developer Guide would be useful by having imperative language ("do this and then do that", etc). I've just seen one spot of confusion where an implementer didn't realise that they had to actually execute the actions that are sent to them via the Actions Endpoint.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant