Review of repo state

[orphefs]

Hi @jason-fox, the past week we have been working on documentation (test cases, tutorial, installation guides) mainly, so we think that part is complete. We still need to version the docker images using tags, however. If there is anything else you'd like to comment on, please do.

[orphefs]

hi @jason-fox, just wanted to make sure you received a notification through this mention.

[jason-fox]

• The readme intro should better summarize what RoboWeldar actually does:
  e.g

. Given a set of photographs of a metallic object destined for welding, this module produces 3D-reconstructed model of that object, along with proposed welding paths.

• https://roboweldar-rose-ap.readthedocs.io/en/latest/README.html does not need to be a repeat of the main README just a summary of the documentation - something closer to this in style
• Add a GitHub Action like this - at least it can lint your code, markdown and dockerfiles. Also explain why you can't run CI full easily in the README if necessary.
• Since you are mainly python files like package.json, eslintrc.json and prettierrc.json can be removed - you can run code formatting and linting using Black or PyPy or whatever.
• Consider adding community files like code-of-conduct or contributing - see https://github.com/ikh-innovation/roboweldar-rose-ap/community
• https://github.com/ikh-innovation/roboweldar-rose-ap/blob/main/docker/Dockerfile - is out-of-date - it is still the example from the template - delete
• Add links from this repo to roboweldar-weld-seam-detection, roboweldar-3d-reconstruction & etc. if they are considered as part of the same project - the easiest way to do this is by describing the interactions in the lede e.g:

This RoseAP uses the weld-seam-detection and 3d-reconstruction to do XYZ

where each one is a link. The alternative is to compose this project using submodules. Either way it should be possible to navigate between dependencies.

• Add links to the following - e.g. https://hub.docker.com/r/roboweldar/roboweldar-weld-seam-detection etc.

Coordinator docker build status:
![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/roboweldar/roboweldar-coordinator?style=plastic)

3D reconstruction docker build status:
![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/roboweldar/roboweldar-3d-reconstruction?style=plastic)

Weld seam detection docker build status:
![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/roboweldar/roboweldar-weld-seam-detection?style=plastic)

• Some of your repos are lacking a description:

See how the Roboteq_diff_driver actually summarizes the purpose of the repo in one short sentence.

Something like

3D model construction of an object with proposed welding paths derived from a set of photographs

you could also add tags to help users find the repo.

• Programming languages in the CII Badge questionnaire are incorrect - remove JavaScript and add Python & etc.

• Most of the remaining CII Badge points could be completed by making a semantically versioned release on GitHub - e.g. 0.0.1 to show evidence of a proper release procedure.

• Similarly you do have a website https://roboweldar-rose-ap.readthedocs.io/ and it does contain documentation in English.

[orphefs]

* The readme intro should better summarize what RoboWeldar actually does:
  e.g

. Given a set of photographs of a metallic object destined for welding, this module produces 3D-reconstructed model of that object, along with proposed welding paths.

Done - please see here .

• https://roboweldar-rose-ap.readthedocs.io/en/latest/README.html does not need to be a repeat of the main README just a summary of the documentation - something closer to this in style

Done - created a mini README.md for use on ReadTheDocs.

• Add a GitHub Action like this - at least it can lint your code, markdown and dockerfiles. Also explain why you can't run CI full easily in the README if necessary.

This is currently in progress ⌛

• Since you are mainly python files like package.json, eslintrc.json and prettierrc.json can be removed - you can run code formatting and linting using Black or PyPy or whatever.

Done

• Consider adding community files like code-of-conduct or contributing - see https://github.com/ikh-innovation/roboweldar-rose-ap/community

Done. See here

• https://github.com/ikh-innovation/roboweldar-rose-ap/blob/main/docker/Dockerfile - is out-of-date - it is still the example from the template - delete

Done

• Add links from this repo to roboweldar-weld-seam-detection, roboweldar-3d-reconstruction & etc. if they are considered as part of the same project - the easiest way to do this is by describing the interactions in the lede e.g:

This RoseAP uses the weld-seam-detection and 3d-reconstruction to do XYZ

where each one is a link. The alternative is to compose this project using submodules. Either way it should be possible to navigate between dependencies.

These are mentioned here and here

• Add links to the following - e.g. https://hub.docker.com/r/roboweldar/roboweldar-weld-seam-detection etc.

Coordinator docker build status:
![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/roboweldar/roboweldar-coordinator?style=plastic)

3D reconstruction docker build status:
![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/roboweldar/roboweldar-3d-reconstruction?style=plastic)

Weld seam detection docker build status:
![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/roboweldar/roboweldar-weld-seam-detection?style=plastic)

Done

* Some of your repos are lacking a description:

See how the Roboteq_diff_driver actually summarizes the purpose of the repo in one short sentence.

Something like

3D model construction of an object with proposed welding paths derived from a set of photographs

you could also add tags to help users find the repo.

Done, please have a look at https://github.com/ikh-innovation/roboweldar-weld-seam-detection, https://github.com/ikh-innovation/roboweldar-networking, and https://github.com/ikh-innovation/roboweldar-3d-reconstruction

• Programming languages in the CII Badge questionnaire are incorrect - remove JavaScript and add Python & etc.

Done.

• Most of the remaining CII Badge points could be completed by making a semantically versioned release on GitHub - e.g. 0.0.1 to show evidence of a proper release procedure.

This is currently in progress ⌛