fixed typos, removed space
This commit is contained in:
parent
676709e706
commit
d851733f6a
|
@ -12,7 +12,7 @@ Help us keep Appwrite open and inclusive. Please read and follow our [Code of Co
|
||||||
|
|
||||||
## Submit a Pull Request 🚀
|
## Submit a Pull Request 🚀
|
||||||
|
|
||||||
Branch naming convention is as following
|
Branch naming convention is as follows
|
||||||
|
|
||||||
`TYPE-ISSUE_ID-DESCRIPTION`
|
`TYPE-ISSUE_ID-DESCRIPTION`
|
||||||
|
|
||||||
|
@ -30,7 +30,7 @@ When `TYPE` can be:
|
||||||
- **fix** - a bug fix
|
- **fix** - a bug fix
|
||||||
- **refactor** - code change that neither fixes a bug nor adds a feature
|
- **refactor** - code change that neither fixes a bug nor adds a feature
|
||||||
|
|
||||||
**All PRs must include a commit message with the changes description!**
|
**All PRs must include a commit message with the a description of the changes!**
|
||||||
|
|
||||||
For the initial start, fork the project and use git clone command to download the repository to your computer. A standard procedure for working on an issue would be to:
|
For the initial start, fork the project and use git clone command to download the repository to your computer. A standard procedure for working on an issue would be to:
|
||||||
|
|
||||||
|
@ -48,7 +48,7 @@ $ git checkout -b [name_of_your_new_branch]
|
||||||
|
|
||||||
3. Work - commit - repeat ( be sure to be in your branch )
|
3. Work - commit - repeat ( be sure to be in your branch )
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
composer format <your file path>
|
composer format <your file path>
|
||||||
|
@ -60,7 +60,7 @@ Now, go a step further by running the linter by the following command to manuall
|
||||||
composer lint <your file path>
|
composer lint <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.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
composer lint --report=diff <your file path>
|
composer lint --report=diff <your file path>
|
||||||
|
@ -116,7 +116,7 @@ After finishing the installation process, you can start writing and editing code
|
||||||
|
|
||||||
#### Advanced Topics
|
#### Advanced Topics
|
||||||
|
|
||||||
We love to create issues that are good for beginners and label them as `good first issue` or `hacktoberfest`, but some more advanced topics might require extra knowledge. Below is a list of links you can use to learn more about some of the more advance topics that will help you master the Appwrite codebase.
|
We love to create issues that are good for beginners and label them as `good first issue` or `hacktoberfest`, but some more advanced topics might require extra knowledge. Below is a list of links you can use to learn more about some of the more advanced topics that will help you master the Appwrite codebase.
|
||||||
|
|
||||||
##### Tools and Libs
|
##### Tools and Libs
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue