Skip to content

Commit a5f7f8b

Browse files
committed
Improve
1 parent 8d23d73 commit a5f7f8b

File tree

4 files changed

+86
-86
lines changed

4 files changed

+86
-86
lines changed

CHANGELOG-3.1.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,32 @@
44

55
### PHP Versions
66

7-
* 🗑️ Drop PHP 7.2 support
7+
* 🗑️ Drop PHP 7.2 support
88

9-
* ✔️ PHP 7.3
9+
* ✔️ PHP 7.3
1010

11-
* ✔️ PHP 7.4
11+
* ✔️ PHP 7.4
1212

13-
* 🚀 Add PHP 8.0
13+
* 🚀 Add PHP 8.0
1414

15-
* 🚀 Add PHP 8.1
15+
* 🚀 Add PHP 8.1
1616

17-
* 🧪 Set PHP 8.2 for nightly
17+
* 🧪 Set PHP 8.2 for nightly
1818

1919
### Symfony Versions
2020

21-
* ✔️ Symfony 4.4
21+
* ✔️ Symfony 4.4
2222

23-
* ✔️ Symfony 5.4
23+
* ✔️ Symfony 5.4
2424

25-
* 🧪 Set Symfony 6.0 for nightly
25+
* 🧪 Set Symfony 6.0 for nightly
2626

2727
### Chore
2828

29-
* ✏️ Add EditorConfig files
29+
* ✏️ Add EditorConfig files
3030

31-
* :octocat: Move CI from Travis to Github Action
31+
* :octocat: Move CI from Travis to Github Action
3232

33-
* 📊 Configure CodeCov
33+
* 📊 Configure CodeCov
3434

35-
* 🔬 Configure Codacy
35+
* 🔬 Configure Codacy

CODE_OF_CONDUCT.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation.
1414
Examples of behavior that contributes to creating a positive environment
1515
include:
1616

17-
* Using welcoming and inclusive language
18-
* Being respectful of differing viewpoints and experiences
19-
* Gracefully accepting constructive criticism
20-
* Focusing on what is best for the community
21-
* Showing empathy towards other community members
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
2222

2323
Examples of unacceptable behavior by participants include:
2424

25-
* The use of sexualized language or imagery and unwelcome sexual attention or
26-
advances
27-
* Trolling, insulting/derogatory comments, and personal or political attacks
28-
* Public or private harassment
29-
* Publishing others' private information, such as a physical or electronic
30-
address, without explicit permission
31-
* Other conduct which could reasonably be considered inappropriate in a
32-
professional setting
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
3333

3434
## Our Responsibilities
3535

CONTRIBUTING.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,36 @@
22

33
## Getting Started
44

5-
* Fork, then clone the repo:
6-
```bash
7-
git clone git@github.com:your-username/symfony-jsonrpc-http-server.git
8-
```
5+
* Fork, then clone the repo:
6+
```bash
7+
git clone git@github.com:your-username/symfony-jsonrpc-http-server.git
8+
```
99

10-
* Make sure everything goes well:
11-
```bash
12-
make build
13-
make test
14-
```
10+
* Make sure everything goes well:
11+
```bash
12+
make build
13+
make test
14+
```
1515

16-
* Make your changes (Add/Update tests according to your changes).
16+
* Make your changes (Add/Update tests according to your changes).
1717

18-
* Make sure tests are still green:
19-
```bash
20-
make test
21-
```
18+
* Make sure tests are still green:
19+
```bash
20+
make test
21+
```
2222

23-
* To check code coverage, launch
24-
```bash
25-
make coverage
26-
```
23+
* To check code coverage, launch
24+
```bash
25+
make coverage
26+
```
2727

28-
* Push to your fork and [submit a pull request](https://github.com/yoanm/symfony-jsonrpc-http-server/compare/).
28+
* Push to your fork and [submit a pull request](https://github.com/yoanm/symfony-jsonrpc-http-server/compare/).
2929

30-
* Wait for feedback or merge.
30+
* Wait for feedback or merge.
3131

3232
Some stuff that will increase your pull request's acceptance:
3333

34-
* Write tests.
35-
* Follow PSR-2 coding style.
36-
* Write good commit messages.
37-
* Do not rebase or squash your commits when a review has been made.
34+
* Write tests.
35+
* Follow PSR-2 coding style.
36+
* Write good commit messages.
37+
* Do not rebase or squash your commits when a review has been made.

README.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,17 @@ See [yoanm/symfony-jsonrpc-http-server-doc](https://github.com/yoanm/symfony-jso
2626

2727
## Versions
2828

29-
* Symfony v3/4 - PHP >=7.1 : `^2.0`
29+
* Symfony v3/4 - PHP >=7.1 : `^2.0`
3030

31-
⚠️⚠️ `v2.1.0` and `v2.1.1` were badly taggued, used `v3.0.0` instead ! ⚠️⚠️
31+
⚠️⚠️ `v2.1.0` and `v2.1.1` were badly taggued, used `v3.0.0` instead ! ⚠️⚠️
3232

33-
* Symfony v4/5 - PHP >=7.2 : `~3.0.0`
33+
* Symfony v4/5 - PHP >=7.2 : `~3.0.0`
3434

35-
* Symfony v4/5 - PHP >=7.3 : `^3.1`
35+
* Symfony v4/5 - PHP >=7.3 : `^3.1`
3636

37-
* Symfony v4.4/5.4 - PHP ^8.0 : `^3.2`
37+
* Symfony v4.4/5.4 - PHP ^8.0 : `^3.2`
3838

39-
* Symfony v4.4/5.4/6.x - PHP ^8.0 : `^3.3`
39+
* Symfony v4.4/5.4/6.x - PHP ^8.0 : `^3.3`
4040

4141
## How to use
4242

@@ -48,41 +48,41 @@ See below how to configure it.
4848

4949
Bundle requires only one thing :
5050

51-
* JSON-RPC Methods which are compatible with [`yoanm/jsonrpc-server-sdk`](https://raw.githubusercontent.com/yoanm/php-jsonrpc-server-sdk)
51+
* JSON-RPC Methods which are compatible with [`yoanm/jsonrpc-server-sdk`](https://raw.githubusercontent.com/yoanm/php-jsonrpc-server-sdk)
5252

5353
It comes with [built-in method resolver](./src/Resolver/MethodResolver.php) which use a [service locator](https://symfony.com/doc/3.4/service_container/service_subscribers_locators.html#defining-a-service-locator). Using a service locator allow to load (and so instanciate dependencies, dependencies of dependencies, etc) method only when required (usually only one method is required by request, except for batch requests which will load one or more methods).
5454

5555
*[Behat demo app configuration folders](./features/demo_app/) can be used as examples.*
5656

57-
* Add the bundles in your `config/bundles.php` file:
58-
```php
59-
// config/bundles.php
60-
return [
61-
...
62-
Symfony\Bundle\FrameworkBundle\FrameworkBundle::class => ['all' => true],
63-
Yoanm\SymfonyJsonRpcHttpServer\JsonRpcHttpServerBundle::class => ['all' => true],
64-
...
65-
];
66-
```
67-
68-
* Add the following in your routing configuration :
69-
```yaml
70-
# config/routes.yaml
71-
json-rpc-endpoint:
72-
resource: '@JsonRpcHttpServerBundle/Resources/config/routing/endpoint.xml'
73-
```
74-
75-
* Add the following in your configuration :
76-
```yaml
77-
# config/config.yaml
78-
framework:
79-
secret: '%env(APP_SECRET)%'
80-
81-
json_rpc_http_server: ~
82-
# Or the following in case you want to customize endpoint path
83-
#json_rpc_http_server:
84-
# endpoint: '/my-custom-endpoint' # Default to '/json-rpc'
85-
```
57+
* Add the bundles in your `config/bundles.php` file:
58+
```php
59+
// config/bundles.php
60+
return [
61+
...
62+
Symfony\Bundle\FrameworkBundle\FrameworkBundle::class => ['all' => true],
63+
Yoanm\SymfonyJsonRpcHttpServer\JsonRpcHttpServerBundle::class => ['all' => true],
64+
...
65+
];
66+
```
67+
68+
* Add the following in your routing configuration :
69+
```yaml
70+
# config/routes.yaml
71+
json-rpc-endpoint:
72+
resource: '@JsonRpcHttpServerBundle/Resources/config/routing/endpoint.xml'
73+
```
74+
75+
* Add the following in your configuration :
76+
```yaml
77+
# config/config.yaml
78+
framework:
79+
secret: '%env(APP_SECRET)%'
80+
81+
json_rpc_http_server: ~
82+
# Or the following in case you want to customize endpoint path
83+
#json_rpc_http_server:
84+
# endpoint: '/my-custom-endpoint' # Default to '/json-rpc'
85+
```
8686

8787
### JSON-RPC Method mapping
8888

0 commit comments

Comments
 (0)