Improve

Author: yoanm

.remarkrc

@@ -1,6 +1,10 @@
 {
   "plugins": [
     "remark-preset-lint-consistent",
-    "remark-preset-lint-recommended"
+    "remark-preset-lint-recommended",
+    [
+      "remark-lint-list-item-indent",
+      "space"
+    ]
   ]
 }

CODE_OF_CONDUCT.md

@@ -23,13 +23,13 @@ include:
 Examples of unacceptable behavior by participants include:
 
 * The use of sexualized language or imagery and unwelcome sexual attention or
- advances
+  advances
 * Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
 * Publishing others' private information, such as a physical or electronic
- address, without explicit permission
+  address, without explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
- professional setting
+  professional setting
 
 ## Our Responsibilities
 

CONTRIBUTING.md

@@ -1,33 +1,39 @@
 # Contributing
 
 ## Getting Started
- * Fork, then clone the repo:
+
+* Fork, then clone the repo:
+
 ```bash
 git clone [email protected]:your-username/symfony-jsonrpc-http-server-swagger-doc.git
-````
+```
+
+* Make sure everything goes well:
 
- * Make sure everything goes well:
 ```bash
 make build
 make test
 ```
 
- * Make your changes (Add/Update tests according to your changes).
- * Make sure tests are still green:
+* Make your changes (Add/Update tests according to your changes).
+* Make sure tests are still green:
+
 ```bash
 make test
 ```
 
- * To check code coverage, launch
+* To check code coverage, launch
+
 ```bash
 make coverage
 ```
 
- * Push to your fork and [submit a pull request](https://github.com/yoanm/symfony-jsonrpc-http-server-swagger-doc/compare/).
- * Wait for feedback or merge.
+* Push to your fork and [submit a pull request](https://github.com/yoanm/symfony-jsonrpc-http-server-swagger-doc/compare/).
+* Wait for feedback or merge.
+
+Some stuff that will increase your pull request's acceptance:
 
-  Some stuff that will increase your pull request's acceptance:
-   * Write tests.
-   * Follow PSR-2 coding style.
-   * Write good commit messages.
-   * Do not rebase or squash your commits when a review has been made.
+* Write tests.
+* Follow PSR-2 coding style.
+* Write good commit messages.
+* Do not rebase or squash your commits when a review has been made.

Makefile

@@ -109,5 +109,13 @@ scrutinizer-behat:
 create-build-directories:
 	mkdir -p ${PHPUNIT_COVERAGE_DIRECTORY} ${BEHAT_COVERAGE_DIRECTORY} ${REPORTS_DIRECTORY}
 
+.PHONY: configure-dev-env
+configure-dev-env:
+	npm install --global remark-cli remark-preset-lint-consistent remark-preset-lint-recommended remark-lint-list-item-indent
+
+.PHONY: lint-markdown
+lint-markdown:
+	npx remark . --output
+
 .PHONY: build install configure test test-unit test-functional codestyle create-build-directories scrutinizer-behat scrutinizer-phpunit
 .DEFAULT: build

README.md

@@ -7,7 +7,7 @@
 
 [![Scrutinizer Build Status](https://img.shields.io/scrutinizer/build/g/yoanm/symfony-jsonrpc-http-server-swagger-doc.svg?label=Scrutinizer\&logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/symfony-jsonrpc-http-server-swagger-doc/build-status/master)
 [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/yoanm/symfony-jsonrpc-http-server-swagger-doc/master.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/symfony-jsonrpc-http-server-swagger-doc/?branch=master)
-[![Codacy Badge](https://app.codacy.com/project/badge/Grade/e50269d2b7bc465fa43a9f9000bc5f06)](https://app.codacy.com/gh/yoanm/symfony-jsonrpc-http-server-swagger-doc/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/e50269d2b7bc465fa43a9f9000bc5f06)](https://app.codacy.com/gh/yoanm/symfony-jsonrpc-http-server-swagger-doc/dashboard?utm_source=gh\&utm_medium=referral\&utm_content=\&utm_campaign=Badge_grade)
 
 [![CI](https://github.com/yoanm/symfony-jsonrpc-http-server-swagger-doc/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/yoanm/symfony-jsonrpc-http-server-swagger-doc/actions/workflows/CI.yml)
 [![codecov](https://codecov.io/gh/yoanm/symfony-jsonrpc-http-server-swagger-doc/branch/master/graph/badge.svg?token=NHdwEBUFK5)](https://codecov.io/gh/yoanm/symfony-jsonrpc-http-server-swagger-doc)
@@ -22,8 +22,8 @@ Symfony bundle for [yoanm/jsonrpc-http-server-swagger-doc-sdk](https://github.co
 
 ## Versions
 
-*   Symfony v3/4 - PHP >=7.1 : `^v0.X`
-*   Symfony v4/5 - PHP >=7.2 : `^v1.0`
+* Symfony v3/4 - PHP >=7.1 : `^v0.X`
+* Symfony v4/5 - PHP >=7.2 : `^v1.0`
 
 ## How to use
 
@@ -35,24 +35,24 @@ See below how to configure it.
 
 [Behat demo app configuration folders](./features/demo_app) can be used as examples.
 
-*   Add the bundles in your config/bundles.php file:
-    ```php
-    // config/bundles.php
-    return [
-        ...
-        Symfony\Bundle\FrameworkBundle\FrameworkBundle::class => ['all' => true],
-        Yoanm\SymfonyJsonRpcHttpServer\JsonRpcHttpServerBundle::class => ['all' => true],
-        Yoanm\SymfonyJsonRpcHttpServerDoc\JsonRpcHttpServerDocBundle::class => ['all' => true],
-        Yoanm\SymfonyJsonRpcHttpServerSwaggerDoc\JsonRpcHttpServerSwaggerDocBundle::class => ['all' => true],
-        ...
-    ];
-    ```
+* Add the bundles in your config/bundles.php file:
+  ```php
+  // config/bundles.php
+  return [
+      ...
+      Symfony\Bundle\FrameworkBundle\FrameworkBundle::class => ['all' => true],
+      Yoanm\SymfonyJsonRpcHttpServer\JsonRpcHttpServerBundle::class => ['all' => true],
+      Yoanm\SymfonyJsonRpcHttpServerDoc\JsonRpcHttpServerDocBundle::class => ['all' => true],
+      Yoanm\SymfonyJsonRpcHttpServerSwaggerDoc\JsonRpcHttpServerSwaggerDocBundle::class => ['all' => true],
+      ...
+  ];
+  ```
 
-*   Configure `yoanm/symfony-jsonrpc-http-server` as described on [yoanm/symfony-jsonrpc-http-server](https://github.com/yoanm/symfony-jsonrpc-http-server) documentation.
+* Configure `yoanm/symfony-jsonrpc-http-server` as described on [yoanm/symfony-jsonrpc-http-server](https://github.com/yoanm/symfony-jsonrpc-http-server) documentation.
 
-*   Configure `yoanm/symfony-jsonrpc-http-server-doc` as described on [yoanm/symfony-jsonrpc-http-server-doc](https://github.com/yoanm/symfony-jsonrpc-http-server-doc) documentation.
+* Configure `yoanm/symfony-jsonrpc-http-server-doc` as described on [yoanm/symfony-jsonrpc-http-server-doc](https://github.com/yoanm/symfony-jsonrpc-http-server-doc) documentation.
 
-*   Query your project at `/doc/swagger.json` endpoint and you will have a swagger json documentation file of your server.
+* Query your project at `/doc/swagger.json` endpoint and you will have a swagger json documentation file of your server.
 
 ## Event