The readme file could be expanded with more detailed specifics, for example:
- Setting up the dev environment;
- Running local tests;
- Checking test coverage (using the shell script);
- Progress bar?
- Mentioning the fact that Laboratory API parameters can differ from documentation;
- Git workflow.
A dedicated 'contributing' document could also be considered.
The readme file could be expanded with more detailed specifics, for example:
A dedicated 'contributing' document could also be considered.