Skip to content

Commit

Permalink
README: describe intended workflow, document known issues
Browse files Browse the repository at this point in the history
  • Loading branch information
qguv committed Apr 25, 2024
1 parent c341d2d commit 410049f
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 410049f

Please sign in to comment.