docs on adding new ci provider

Author: krzkaczor

README.md

@@ -36,6 +36,7 @@ Expect more docs soon...
 1. [Client API reference](client-api.md)
 1. [Local mode](local-mode.md)
 1. [Supported CI providers](supported-ci.md)
+   1. [Adding new CI](adding-new-ci.md)
 1. [Debugging](debugging.md)
 1. [Badges](badges.md)
 1. [FAQ](faq.md)

adding-new-ci.md

@@ -0,0 +1,16 @@
+# Adding new CI
+
+This is a mini-guide on adding new CI provider to
+[JavaScript client](https://github.com/codechecks/monorepo).
+
+1. Create new file in `packages/client/src/ci-providers`. You can copy `Circle.ts` and use it as
+   scaffolding.
+2. If your CI creates explicit CI run on PR creation then set `supportsSpeculativeBranchSelection`
+   to false. Otherwise return true. For example: CircleCI always runs your code on push. That's why
+   we sometimes need to "guess" base branch (only before PR is really created by the user).
+   [Read more](https://github.com/codechecks/docs/blob/master/configuration.md#speculative-branch-execution)
+
+3. Implement rest of the class
+4. Don't forget to add tests. Currently we test new CI providers by adding raw environment dump (you
+   can use `printenv`) and asserting correct data.
+   [Example](https://github.com/codechecks/monorepo/blob/master/packages/client/src/ci-providers/__tests__/Circle.test.ts)

developing-checks.md

@@ -5,11 +5,14 @@ In this tutorial we are gonna build simplified version of
 watch size of a single file and doesn't support gzip. We are gonna use yarn in this tutorial but you
 can pick npm as well. Lets' start!
 
+## Scaffolding
+
 We want our check to be fully reusable so we are gonna create new npm package just for it.
 
 ```sh
 mkdir simple-build-size-watcher
 cd simple-build-size-watcher
+# creates package.json
 yarn init -y
 ```
 
@@ -19,17 +22,24 @@ Let's install codechecks client.
 yarn add --dev @codechecks/client
 ```
 
-Let's start developing index.js file. Our check is just a function that takes a path to a file that
-we want to observe and it a default export of a module.
+Let's start developing `index.js` file. Our check is just a function that takes options object, in
+this example it's a path to a file that we want to observe. The function is a default export of a
+module.
 
 ```js
 const { codechecks } = require("@codechecks/client");
 
-module.exports = function(path) {
-  // it's alive!
+module.exports = function({ path }) {
+  // just print out the path
+  codechecks.success({ name: "Simple build size", shortDescription: path });
 };
 ```
 
+At this point we have already something very simple that should work. To test it we need to create a
+`codechecks.yml` file that actually uses this file.
+
+## Getting real
+
 Lets calculate size of a file pointed by a path. After quick visit at stackoverflow we can come up
 with a function getSize:
 
@@ -105,7 +115,7 @@ function getSize(path) {
 
 That's it. Whole code is placed in `/example` directory of this repo.
 
-## Testing
+# Testing
 
 Because codechecks client is an external dependency that is supposed to be imported by your modules
 this makes testing a little bit harder. We recommend to use jest mocking super powers. Tests for
@@ -114,7 +124,7 @@ this project are part of `/example` dir.
 You can find more complicated example here:
 https://github.com/codechecks/build-size-watcher/tree/master/src/__tests__
 
-## Debugging
+# Debugging
 
 For compatibility with codechecks client, to provide debug logs use `debug` package with
 `codechecks:YOUR_CHECK_NAME` namespace.

roadmap.md

@@ -9,7 +9,7 @@ Not in any particular order.
       [[email protected]](mailto:[email protected]))
 - [x] Speculative base branch selection when PR doesnt exist yet
 - [x] Travis CI support
-- [ ] Awesome Codechecks list
+- [x] Awesome Codechecks list
 - [ ] Codechecks ideas:
-  - [ ] Visual Regression codecheck
+  - [x] Visual Regression codecheck
   - [ ] Test coverage like codecov codecheck

supported-ci.md

@@ -4,4 +4,5 @@
 - Travis CI
 
 Is your favorite CI provider missing? Just create an issue
-[here](https://github.com/codechecks/monorepo).
+[here](https://github.com/codechecks/monorepo). You can implement it on your own, read this
+[quick guide](adding-new-ci.md)