Skip to content

Commit 02875e3

Browse files
committed
Fix doc links, added screenshots
1 parent 3b0a076 commit 02875e3

File tree

5 files changed

+16
-18
lines changed

5 files changed

+16
-18
lines changed

.github/docs/coding-standards.png

108 KB
Loading

.github/docs/phpstan.png

99.4 KB
Loading

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Contributions of any kind are welcome! If you've found a bug or have a feature r
44

55
To make changes yourself, follow these steps:
66

7-
1. Follow the [Setup Guide](SETUP.MD) to set up your environment and clone this repository
8-
2. Follow the [Development Guide](DEVELOPMENT.MD) to create a branch and make changes
9-
3. Refer to the [Testing Guide](TESTING.MD) to write applicable unit tests and submit your pull request.
7+
1. Follow the [Setup Guide](SETUP.md) to set up your environment and clone this repository
8+
2. Follow the [Development Guide](DEVELOPMENT.md) to create a branch and make changes
9+
3. Refer to the [Testing Guide](TESTING.md) to write applicable unit tests and submit your pull request.
1010

1111
Thanks!

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,13 @@ or `ServerException` (for 5xx errors).
5151

5252
```php
5353
try {
54-
$forms = $api->add_subscriber_to_form('invalid-form-id');
54+
$forms = $api->add_subscriber_to_form('invalid-form-id');
5555
} catch (GuzzleHttp\Exception\ClientException $e) {
56-
// Handle 4xx client errors.
56+
// Handle 4xx client errors.
5757
die($e->getMessage());
5858
} catch (GuzzleHttp\Exception\ServerException $e) {
59-
// Handle 5xx server errors.
60-
die($e->getMessage());
59+
// Handle 5xx server errors.
60+
die($e->getMessage());
6161
}
6262
```
6363

@@ -66,16 +66,16 @@ For a more detailed error message, it's possible to fetch the API's response whe
6666
```php
6767
// Errors will be thrown as Guzzle's ClientException or ServerException.
6868
try {
69-
$forms = $api->form_subscribe('invalid-form-id');
69+
$forms = $api->form_subscribe('invalid-form-id');
7070
} catch (GuzzleHttp\Exception\ClientException $e) {
71-
// Handle 4xx client errors.
72-
// For ClientException, it's possible to inspect the API's JSON response
73-
// to output an error or handle it accordingly.
71+
// Handle 4xx client errors.
72+
// For ClientException, it's possible to inspect the API's JSON response
73+
// to output an error or handle it accordingly.
7474
$error = json_decode($e->getResponse()->getBody()->getContents());
7575
die($error->message); // e.g. "Entity not found".
7676
} catch (GuzzleHttp\Exception\ServerException $e) {
77-
// Handle 5xx server errors.
78-
die($e->getMessage());
77+
// Handle 5xx server errors.
78+
die($e->getMessage());
7979
}
8080
```
8181

SETUP.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ If you're new to this, use [GitHub Desktop](https://desktop.github.com/) or [Tow
3838

3939
### Configure Testing Environment
4040

41-
Copy the `.env.example` file to `.env` in the root of this repository, changing folder and database credentials as necessary:
41+
Copy the `.env.example` file to `.env` in the root of this repository, adding your ConvertKit API keys.
4242

4343
```
4444
CONVERTKIT_API_KEY_NO_DATA=
@@ -107,8 +107,6 @@ correctly setup your environment:
107107
vendor/bin/phpunit
108108
```
109109

110-
![PHPUnit Test Results](/.github/docs/phpunit.png?raw=true)
111-
112110
Don't worry if you don't understand these commands; if your output looks similar to the above screenshot, and no test is prefixed with `E`,
113111
your environment is setup successfully.
114112

@@ -117,8 +115,8 @@ your environment is setup successfully.
117115
In the root directory, run the following commands to run PHP_CodeSniffer, which will check the code meets PHP Coding Standards:
118116

119117
```bash
120-
vendor/bin/phpcs
121-
vendor/bin/phpcs --standard=phpcs.tests.xml
118+
vendor/bin/phpcs -s -v
119+
vendor/bin/phpcs -s -v --standard=phpcs.tests.xml
122120
```
123121

124122
![Coding Standards Test Results](/.github/docs/coding-standards.png?raw=true)

0 commit comments

Comments
 (0)