Update CONTRIBUTING.md
This commit is contained in:
parent
cc57a9f347
commit
52b7bb50d0
|
@ -45,18 +45,18 @@ $ git checkout -b [name_of_your_new_branch]
|
||||||
|
|
||||||
4. Before you push your changes, make sure your code follows the `PSR12` coding standards , which is the standard Appwrite follows currently.
|
4. Before you push your changes, make sure your code follows the `PSR12` coding standards , which is the standard Appwrite follows currently.
|
||||||
You can easily do this by running the formatter
|
You can easily do this by running the formatter
|
||||||
```
|
```php
|
||||||
./vendor/bin/phpcbf --standard=PSR12 <your file path>
|
./vendor/bin/phpcbf --standard=PSR12 <your file path>
|
||||||
```
|
```
|
||||||
This will format the code according to the `PSR12` coding standard.
|
This will format the code according to the `PSR12` coding standard.
|
||||||
|
|
||||||
Now, go a step further by running the linter by the following command to manually fix the issues the formatter wasn't able to fix
|
Now, go a step further by running the linter by the following command to manually fix the issues the formatter wasn't able to fix
|
||||||
```
|
```php
|
||||||
./vendor/bin/phpcs --standard=PSR12 <your file path>
|
./vendor/bin/phpcs --standard=PSR12 <your file path>
|
||||||
```
|
```
|
||||||
This will give you a list of errors for you to rectify , if there is an instance you need more information on the errors being displayed you can pass in additional command line arguments. More list of available arguments can be found [here](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage). A very useful command line argument is `--report=diff`. This will give you the expected changes by the linter for easy fixing of formatting issues
|
This will give you a list of errors for you to rectify , if there is an instance you need more information on the errors being displayed you can pass in additional command line arguments. More list of available arguments can be found [here](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage). A very useful command line argument is `--report=diff`. This will give you the expected changes by the linter for easy fixing of formatting issues
|
||||||
|
|
||||||
```
|
```php
|
||||||
./vendor/bin/phpcs --standard=PSR12 --report=diff <your file path>
|
./vendor/bin/phpcs --standard=PSR12 --report=diff <your file path>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -66,7 +66,7 @@ $ git push origin [name_of_your_new_branch]
|
||||||
```
|
```
|
||||||
6. Submit your changes for review
|
6. Submit your changes for review
|
||||||
If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button.
|
If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button.
|
||||||
7. Start a Pull Request
|
7. Start a Pull Request
|
||||||
Now submit the pull request and click on `Create pull request`.
|
Now submit the pull request and click on `Create pull request`.
|
||||||
8. Get a code review approval/reject
|
8. Get a code review approval/reject
|
||||||
9. After approval, merge your PR
|
9. After approval, merge your PR
|
||||||
|
|
Loading…
Reference in a new issue