search

MycroftAI / mycroft-core

Mycroft Core, the Mycroft Artificial Intelligence platform.
https://mycroft.ai
Apache License 2.0
6.51k stars 1.27k forks source link

Added comments to document race condition #2945

Closed chrisveilleux closed 3 years ago

chrisveilleux commented 3 years ago

Description

PR2937 addressed an issue with a race condition but no comments were added to describe the problem and the work around to address it. This PR adds those comments.

How to test

No testing necessary. Only comments touched.

Contributor license agreement signed?

CLA [Y]

codecov-commenter commented 3 years ago

Codecov Report

Merging #2945 (843e2b2) into dev (2deab67) will not change coverage. The diff coverage is n/a.

:exclamation: Current head 843e2b2 differs from pull request most recent head 18cb280. Consider uploading reports for the commit 18cb280 to get more accurate results Impacted file tree graph

@@           Coverage Diff           @@
##              dev    #2945   +/-   ##
=======================================
  Coverage   52.64%   52.64%           
=======================================
  Files         123      123           
  Lines       11021    11021           
=======================================
  Hits         5802     5802           
  Misses       5219     5219
Impacted Files Coverage Δ
mycroft/skills/mycroft_skill/mycroft_skill.py 74.69% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 2deab67...18cb280. Read the comment docs.

devops-mycroft commented 3 years ago

Voight Kampff Integration Test Succeeded (Results)

chrisveilleux commented 3 years ago

Nice, maybe we should open an issue as well?

There is an issue in the internal ticketing system for this. I am not sure if we have a clear delineation for what goes into GitHub issues vs. Mycroft's internal issue tracker.

krisgesling commented 3 years ago

Until we can setup a syncing system between them, I think we should ideally have a public issue for anything that is of interest to the broader community. This would be particularly useful if downstream projects might have a vested interested in fixing it and contributing that fix back.

I've tried to do this a bit with internal tickets and include a link to the public issue, but it is a pain trying to maintain two listings.