Skip to content

Commit 7ff2404

Browse files
author
Benjamin Wilson Friedman
authored
Added CONTRIBUTING link and documented usage of 'document-check'
1 parent 3571490 commit 7ff2404

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

CONTRIBUTING.md

+4
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,10 @@ Make sure your code is linted with phpcs ([PSR-2 Coding Style]):
7676
You can automatically fix lint errors with phpcbf:
7777

7878
npm run lint:fix
79+
80+
Finally verify that your new changes are acceptable to phpdoc:
81+
82+
npm run document-check
7983

8084
The test suite is setup for code coverage if you have [XDebug] installed and setup.
8185
Coverage is outputted as text and as html in the phpunit-test-results/ directory within the project root.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ if(ParsePush::hasStatus($response)) {
324324
Contributing / Testing
325325
----------------------
326326

327-
See the CONTRIBUTORS.md file for information on testing and contributing to
327+
See [CONTRIBUTING](CONTRIBUTING.md) for information on testing and contributing to
328328
the Parse PHP SDK. We welcome fixes and enhancements.
329329

330330
[Get Composer]: https://getcomposer.org/download/

0 commit comments

Comments
 (0)