Skip to content

Commit d7f19b3

Browse files
committed
🤔 add FAQ section
1 parent 1a45c99 commit d7f19b3

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

‎README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,5 @@ Expect more docs soon...
3636
1. Developing reusable checks
3737
1. Testing checks
3838
1. Client API reference
39+
1. [FAQ](faq.md)
3940
1. Roadmap

‎faq.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# FAQ
2+
3+
## Q: How does codechecks relate to DangerJS?
4+
5+
DangerJS is a library, codechecks is a platform. This means many things but most importantly
6+
DangerJS lacks "memory", you can't compare things that happened on the other commit. This is solved
7+
by Storage API in codechecks where you upload any artifacts so you can easy access them later.
8+
9+
Another issue is user onboarding process, we provide already existing GitHub app which makes
10+
onboarding process easy and familiar to our users. You install GitHub app on your repos, you copy
11+
secret value generated for you and put it into your CI config and you're ready to go. With Danger
12+
you need to create manually Github bot, generate access keys etc.
13+
14+
Other differences include: we use github checks API that it's way more powerful than putting
15+
comments in your code. We embrace plugin infrastructure where particular checks (like ex. visual
16+
regression) are reusable between projects and distributed as NPM packages.
17+
18+
## Q: How is it different from BundleWatcher, Codecov, Percy?
19+
20+
All of these tools do just one particular thing (track build size, code coverage of visual
21+
regressions) so you need to maintain all of them. They require multiple secrets, repeated
22+
installations and every tool is configured differently. Sometimes config is not even part of your
23+
repository but users are forced to click through some UIs. Also, most of them are closed source and
24+
you can't easily fix things when they are broken.
25+
26+
On the other hand, with codechecks you keep whole configuration in one readable, declarative file
27+
and all you need to do is install add one secret. Furthermore, everything is open source and you can
28+
easily tweak particular checks. What's even more inspiring is that you can explore new ideas that
29+
were never done before like for example type coverage tracking in TypeScript projects.
30+
31+
## Q: What's the business model?
32+
33+
Our whole platform is open source. You can use it and run on your own servers and never pay us any
34+
cent for this. But to create sustainable development model (ship new features, write new official
35+
checks, maintain already created ones) we provide SASS product available at codechecks.io.
36+
codechecks.io is 100% free for any open source projects. We charge only for private repositories. We
37+
also provide consultancy services and premium support for self hosted instances for additional fees.

0 commit comments

Comments
 (0)