From b58fb496a11db95c21dfb17e0a6ea9b87b0e4662 Mon Sep 17 00:00:00 2001 From: i0natan Date: Wed, 13 Feb 2019 18:30:30 +0200 Subject: [PATCH] fsd --- CODE_OF_CONDUCT.md | 2 +- CONTRIBUTING.md | 16 ++++++++++++---- readme.md | 4 +++- 3 files changed, 16 insertions(+), 6 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 00f9dbf..d62a514 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,3 +1,3 @@ There's no code of conduct here, just a super friendly atmosphere -p.s. reminder - you can't be a true professional without being nice and modest \ No newline at end of file +p.s. a friendly reminder - you can't be a true professional without being nice and modest \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bdfa592..36cc030 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,6 +9,7 @@ - [How To](#how-to) ## Joining our team +Just open an issue and state your willingness to join the team. Will take care for the rest ## Stack @@ -27,15 +28,22 @@ Node.js backend, no DB, frontend with React, testing with Jest, Travis for CI, . ## How To **How do I setup my machine for development?** - simply: -- Git clone https://github.com/i0natan/node-chaos-monkey -- npm i -- npm run start:dev +- `Git clone https://github.com/i0natan/node-chaos-monkey` +- `npm i` +- `npm run test:manual` Consider developing on a dedicated branch -**How do I test my new code?** - until we will add some automated tests, the only alternative is manual testing. Under ~/tests/manual-testing-with-simple-web-app there is a simple Express web application that uses the chaos-monkey. Navigate to this directory, start the app with "npm start" and the chaos-monkey will get hosted in this app. Now you can check your new functionality the way you like, for example by calling the chaos-api +**How do I test my new code?** - until we will add some automated tests, the only viable alternative is manual testing. For this purpose, we've created a simple express app that host the chaos monkey Under ~/tests/manual-testing-with-simple-web-app. +To start running the test app just type from the root: +`npm run test:manual` + +The test app reference the chaos-monkey directly so any changes you'll make will affect immediately without any need to re-publish to npm **Wanna add a new prank (type of damage)? -** Go to ~/lib/pranks and copy one of the existing pranks, change the class name and override the "Start" and "Stop" methods with your own logic. Then, visit ~/lib/pranks/pranks-definition.js and add your new prank to the list +**Wanna change the UI-** visit ~/ui where the React app is located. An handful of package.json scripts will help you build and watch the code + + diff --git a/readme.md b/readme.md index 20b5a76..890ae1c 100644 --- a/readme.md +++ b/readme.md @@ -8,6 +8,8 @@ 74 items Last update: October 7th, 2018 Updated for Node 8.11.3 LTS +### **Caution: Alpha mode, we're now stabilizing the functionality and enhancing the docs. Consider contributing or visiting again soon** +
## Don't go to production without 10 minutes of application-level chaos testing @@ -24,7 +26,7 @@ Functional bugs are just a subset of the bad things that happen in production. I Deploy like a pro by spending as little as 10 minutes on Chaos Testing: -**1.** Simulate some bad things (e.g. event loop is blocked) +**1.** Simulate some bad things (e.g. event loop is blocked, error rate is inclining) **2.** Approach your APIs to ensure they function correctly