Skip to content

Commit 547eb99

Browse files
authored
docs: add developer docs (#300)
1 parent 8dbe6ff commit 547eb99

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

CONTRIBUTING.md

+4
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ There are git hooks set up with this project that are automatically installed
3737
when you install dependencies. They're really handy, and will take care of linting
3838
and formatting for you.
3939
40+
## Thinking of a new feature?
41+
42+
Make sure you read our [features guidelines](/docs/features.md).
43+
4044
## Help needed
4145
4246
Please checkout the [the open issues][issues]

docs/features.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Contributing with a new feature
2+
3+
If you are thinking about adding a new feature to [Testing Playground](https://testing-playground.com/) and wondering where to start, you are in the right place.
4+
5+
First, make sure that doesn't exist yet as [feature request](https://github.com/testing-library/testing-playground/issues?q=is%3Aissue+is%3Aopen+label%3Afeature). If it doesn't, go ahead and [create it](https://github.com/testing-library/testing-playground/issues/new?labels=feature&template=2.feature.md).
6+
7+
We will advise you to first gather some feedback from the community and then proceed with coding.
8+
9+
The project is divided on two applications:
10+
11+
- [The website](https://testing-playground.com/) (in `src/`)
12+
- [The Extension](https://chrome.google.com/webstore/detail/testing-playground/hejbmebodbijjdhflfknehhcgaklhano?hl=en) (in `devtools/`)
13+
14+
Have a look at the code to get the big picture, and follow the patterns we are currently using (naming conventions, folder structure...etc.).
15+
16+
This is how our component hierarchy looks like right now:
17+
18+
![Component hierarchy](https://user-images.githubusercontent.com/1196524/85944695-17b16e80-b939-11ea-922b-ab00245a364a.png)
19+
20+
## You should also know...
21+
22+
- We use [Taildwind](https://tailwindcss.com/) for CSS.
23+
- We use [ReachUI](https://reach.tech/) for interactive UI elements
24+
- We use [Octicons](https://primer.style/octicons/) icons
25+
- We use [undraw](https://undraw.co/illustrations) for illustrations
26+
- With color `#EDF2F7` and `.5` opacity.

0 commit comments

Comments
 (0)