Coder Social home page Coder Social logo

Comments (4)

kd-ods avatar kd-ods commented on July 24, 2024

To add some detail. The documentation should explain:

  • What the test setup is in the repo. (e.g. where the tests reside ... /test directory)
  • What the tests do or look for.
  • Whether and when the tests are run automatically.
  • How they can be run locally (e.g. for development)
  • Whether they can be run in isolation (eg just test_csv.py)
  • How to add test data (is 'fixtures' the right term??). Is it important, eg, that test json files in the data/*-statement directories only have a single statement object in them (not an array)? (At the moment, the PLCs files in the entity-statement directories are are arrays.)

(@siwhitehouse @ScatteredInk - anything to add here?)

from bods-dev-handbook.

ScatteredInk avatar ScatteredInk commented on July 24, 2024

Thanks @kd-ods, this looks good.

Whether and when the tests are run automatically.

I think an overview of the CI/build process would be helpful, including the rules on merging - this feels like an assumption at the moment.

We might also benefit from a high-level statement of what should be tested and what is tested, e.g. test all example data, code conventions.

from bods-dev-handbook.

kd-ods avatar kd-ods commented on July 24, 2024

This ticket in the main repo can be closed once the dev handbook is updated with test info.

from bods-dev-handbook.

rhiaro avatar rhiaro commented on July 24, 2024

Fixed in #58

from bods-dev-handbook.

Related Issues (19)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.