Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DimaIT authored Apr 26, 2024
1 parent d3096fa commit d8f4d7a
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@

[^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
## Filling the data

### 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:
Expand All @@ -31,6 +34,17 @@
- 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!)

### Grouping the changes

Each individual change from CMS results in a commit. Editing support for many features results in commit spam.

For multiple changes it's recommended to create a separate branch. It can be selected in the top left dropdown in the CMS.

Once the changes are ready - the PR based on the branch can be squashed and merged. All changes will be grouped in one commit.

<img src="https://github.com/surfly/compat/assets/11188888/c4a5c2ba-b94e-41b6-9b4f-cd521d533bed" width="400">
<img src="https://github.com/surfly/compat/assets/11188888/60296166-a441-4a44-8b02-9c7101b004e0" width="400">

## Known issues

- the search feature in the public instance of Pages CMS is not currently working

0 comments on commit d8f4d7a

Please sign in to comment.