Comments (4)
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.
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.
This ticket in the main repo can be closed once the dev handbook is updated with test info.
from bods-dev-handbook.
Fixed in #58
from bods-dev-handbook.
Related Issues (19)
- Add branching policy/guidance HOT 1
- Consider changing Git branch name scheme to be PEP440 compliant HOT 3
- Codelist capitalisation
- "you must always use the bracket notation" HOT 1
- Update docs section of the handbook HOT 1
- Write docs on creating and maintaining SVG diagrams HOT 1
- Add guidance on maintenance of the reference.rst page HOT 8
- FYI, OCDS considering moving its handbook to Gitbook HOT 1
- Add translation guidance from data-standard README
- FYI, OCDS using Airtable for tools HOT 1
- Update Feature development pipeline page re proposals
- Use a theme with a table of contents side menu
- Clarify use of 'legal entity' in style guide HOT 1
- Further diagram guidance within the style guide
- Document how codelists are managed for BODS HOT 2
- format validation for invalid files HOT 2
- Add to styleguide, how to mark-up property values
- Draft a style guide HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from bods-dev-handbook.