Skip to content

Devise an approach for testing and documenting Flock's API #150

@julianharty

Description

@julianharty

Context

The API, documentation, and tests have been developed inconsistently on an ad-hoc basis. We'd like them to be consistent, documented, and tested by automated tests so the project team can continue to develop and revise the codebase with increased confidence through trustworthy automated tests that exercise typical usage of the API by end users.

Note: automated tests are extremely unlikely to detect all breaking changes and all adverse behaviours/effects. This issue is intended to cover the basic foundations that will facilitate ongoing improvements to the APIs, their documentation, and the range and depth of automated tests and testing.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions