Skip to content

Commit c480f15

Browse files
committed
docs: add roadmap
1 parent 5d41271 commit c480f15

File tree

2 files changed

+60
-0
lines changed

2 files changed

+60
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,12 @@ Testing-Playground provides you with direct feedback. Trying to visualize the di
1010

1111
[testing-library/dom]: https://testing-library.com/docs/dom-testing-library/example-intro
1212
[demo]: https://testing-playground.com
13+
14+
# Roadmap
15+
16+
Future ideas are maintained in the [roadmap]. Please use the [issue tracker] to discuss any questions or suggestions you have.
17+
18+
Every section in the roadmap is accompanied by one or more issues. Contributions are most welcome!
19+
20+
[roadmap]: https://github.com/smeijer/testing-playground/blob/master/ROADMAP.md
21+
[issue tracker]: https://github.com/smeijer/testing-playground/issues

ROADMAP.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Roadmap
2+
3+
## Interactive HTML Preview
4+
5+
_Status: Shipped at May 23, 2020_
6+
7+
The html preview tab should be made interactive. In such a way that one can hover elements and see the recommended query. When clicking on the link, the query should applied to the editor, like the various query buttons do.
8+
9+
## Update Readme.md
10+
11+
_Status: In backlog (#5, #6)_
12+
13+
We don't have any instructions on how to get the thing started at localhost, or how to contribute. This should be made crystal clear.
14+
15+
Also, I have no idea how it works, but I know we need to use emoji-key to list contributors in the readme. Is that an automated thing?
16+
17+
## Add tests
18+
19+
_Status: In backlog (#7)_
20+
21+
A [testing-playground.com] without tests... I don't think that should be a thing, but at this moment it is.
22+
23+
We should fix that, and use jest & testing-library to do it.
24+
25+
## Usage instructions
26+
27+
_Status: In backlog (#8)_
28+
29+
Do we need some instructions on how to use the tool? I'm not sure about this yet, but if we do, it should be added to the playground itself. Not just a markdown on github.
30+
31+
## Embeddable
32+
33+
_Status: In backlog (#9)_
34+
35+
How awesome would it be if we had an embed-mode, so users can embed the playground in the blogs they write about testing / testing-library?
36+
37+
## Support User-Event
38+
39+
_Status: In backlog (#10)_
40+
41+
I haven't worked out the details, but enabling users to play with [user-event]s would awesome. Perhaps together with adding support for [HTML mixed mode]?
42+
43+
## DevTools!
44+
45+
_Status: In backlog (#11)_
46+
47+
I believe we can wrap this project into a chrome extension. That way people can use the thing on their own sites, without needing to copy / paste html fragments. How awesome would that be?!
48+
49+
[testing-playground.com]: https://testing-playground.com
50+
[html mixed mode]: https://codemirror.net/mode/htmlmixed/index.html
51+
[user-event]: https://testing-library.com/docs/ecosystem-user-event

0 commit comments

Comments
 (0)