From 410049f4287dc982252e08ea20aee495ac7d1cd4 Mon Sep 17 00:00:00 2001 From: Quint Guvernator Date: Thu, 25 Apr 2024 16:14:28 +0200 Subject: [PATCH] README: describe intended workflow, document known issues --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 3f7a7ea8b..ad43a6634 100644 --- a/README.md +++ b/README.md @@ -12,3 +12,25 @@ - run `pipenv run ./overlay.py` to create JSON files of browser compatibility data in the format used by MDN; generated data will be saved in the `data` branch of this repository [^1]: The demo page source is stored in a directory named `docs` because this is the only non-root directory name that gh-pages can deploy from without creating a custom Github Actions workflow. + +## How to investigate a feature + +- If there's a test for this feature, that's already enough evidence that it's supported. Mark the feature as "supported" and mention the path to the test source. You're done! +- If there's no test for this feature, write one in one of the Surfly suites: + - if your test passes: + - mark the feature as supported + - create a PR to cobro with your new test + - if your test fails: + - mark the feature as TODO (or NEVER, or partial, etc.) + - create an issue to add support for this feature +- If there's no way to test this currently, try testing manually in glitch.me or similar. + - if the feature works under Surfly: + - mark the feature as supported (or partial, etc.) + - create an issue to add tests for this feature (and mention your manual testing strategy!) + - if the feature doesn't work under Surfly: + - mark the feature as TODO (or NEVER, or partial, etc.) + - create an issue to add support and tests for this feature (and mention your manual testing strategy!) + +## Known issues + +- the search feature in the public instance of Pages CMS is not currently working