Title: All exercise test files should reference canonical data version · Issue #784 · exercism/python · GitHub
Open Graph Title: All exercise test files should reference canonical data version · Issue #784 · exercism/python
X Title: All exercise test files should reference canonical data version · Issue #784 · exercism/python
Description: Currently some of the test files reference x-common//canonical-data.json with a version number, and a few test files lack any such a reference. Additionally, x-common was recently renamed to problem-specifications, so references to x-com...
Open Graph Description: Currently some of the test files reference x-common//canonical-data.json with a version number, and a few test files lack any such a reference. Additionally, x-common was recently renamed to proble...
X Description: Currently some of the test files reference x-common//canonical-data.json with a version number, and a few test files lack any such a reference. Additionally, x-common was recently renamed to proble...
Opengraph URL: https://github.com/exercism/python/issues/784
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"All exercise test files should reference canonical data version","articleBody":"Currently some of the test files reference `x-common//canonical-data.json` with a version number, and a few test files lack any such a reference. Additionally, `x-common` was recently renamed to `problem-specifications`, so references to `x-common` are inherently outdated and potentially confusing.\r\n\r\nHaving a consistent version string should help with maintenance, since a script can fairly easily be written to compare the version numbers in the test file and the canonical data, and manual checks for how up to date it is are similarly easy. It also makes it easier for exercism users to find and check the canonical data, and thus to be able to contribute any changes they think are necessary if they identify problems or additional tests that would be useful.\r\n\r\n### Suggested wording\r\n\r\nThe currently adopted form for the version string seems to be:\r\n``# test cases adapted from `x-common//canonical-data.json` @ version: 1.0.1``\r\n\r\nTo conform to PEP8, we should aim to limit the string to 79 characters, so I propose the following wording (75 chars):\r\n``# Tests adapted from `problem-specifications//canonical-data.json` @ v2.0.0``\r\n\r\nDoes anyone have any alternatives or suggestions for improvements to this wording?\r\n\r\n### How to proceed\r\n\r\nThere are a couple of options for how to go about updating the test files:\r\n1. Only update version strings when the tests are next updated, and update tests when the canonical data change.\r\n1. Systematically update each test file to match the most recent canonical data version (or verify that it's already up-to-date), and update the version strings in the process.\r\n\r\nOption 1 is obviously the less work-intensive one, but it would leave some inconsistency for quite a while. Option 2 is more work-intensive and should get everything up-to-date quicker, but it might burn people out a bit.","author":{"url":"https://github.com/N-Parsons","@type":"Person","name":"N-Parsons"},"datePublished":"2017-10-09T18:07:48.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":14},"url":"https://github.com/784/python/issues/784"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:79b3c9dc-7bd5-26fc-9937-f9aeb80bb6c1 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | D012:30313E:13F5A:1AC36:69695FA3 |
| html-safe-nonce | 04f415edc9306fdf903c3dc3e839f56893fab517b61b96e21e713faa7ffdb6f9 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEMDEyOjMwMzEzRToxM0Y1QToxQUMzNjo2OTY5NUZBMyIsInZpc2l0b3JfaWQiOiIyNTA3NDcxNTI2Mjk4MjE0MzA3IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | d64d70ace8d54b4c809dd81af55406f9ddb70a1c828fbeb14feffa7c1fbe60c9 |
| hovercard-subject-tag | issue:263980373 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/exercism/python/784/issue_layout |
| twitter:image | https://opengraph.githubassets.com/254ec7ee949b2b17b8d2aabfce19a6643e5d91d962cbff989b124218db9b389f/exercism/python/issues/784 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/254ec7ee949b2b17b8d2aabfce19a6643e5d91d962cbff989b124218db9b389f/exercism/python/issues/784 |
| og:image:alt | Currently some of the test files reference x-common//canonical-data.json with a version number, and a few test files lack any such a reference. Additionally, x-common was recently renamed to proble... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | N-Parsons |
| hostname | github.com |
| expected-hostname | github.com |
| None | 48487c1ad776a7975b7132d95f4240ff3ae37cd5b8e3cb597102a4edb76738f1 |
| turbo-cache-control | no-preview |
| go-import | github.com/exercism/python git https://github.com/exercism/python.git |
| octolytics-dimension-user_id | 5624255 |
| octolytics-dimension-user_login | exercism |
| octolytics-dimension-repository_id | 17274389 |
| octolytics-dimension-repository_nwo | exercism/python |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 17274389 |
| octolytics-dimension-repository_network_root_nwo | exercism/python |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 669463fcc54773a88c1f5a44eef6b99a5504b9c7 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width