From 2d05aef1c2a9b6fb445b4dd57dc839105d5a7063 Mon Sep 17 00:00:00 2001 From: Jonah Lawrence Date: Thu, 1 Oct 2020 00:44:50 +0300 Subject: [PATCH] Fixed grammar and spelling in CONTRIBUTING.md --- CONTRIBUTING.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0cb27cde2..0ef3e734c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +29,7 @@ When `TYPE` can be: - **fix** - a bug fix - **refactor** - code change that neither fixes a bug nor adds a feature -**All PRs must include commit message with the changes description!** +**All PRs must include a commit message with the changes description!** 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,13 +48,13 @@ $ git checkout -b [name_of_your_new_branch] $ git push origin [name_of_your_new_branch] ``` -6. Submit your changes for review +5. 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. -7. Start a Pull Request -Now submit the pull request and , click on `Create pull request`. -6. Get a code review approval / reject -7. After approval, merge your PR -8. GitHub will automatically delete the branch, after the merge is done. (they can still be restored). +6. Start a Pull Request +Now submit the pull request and click on `Create pull request`. +7. Get a code review approval/reject +8. After approval, merge your PR +9. GitHub will automatically delete the branch after the merge is done. (they can still be restored). ## Setup From Source @@ -177,9 +177,9 @@ Appwrite uses [PHP's Composer](https://getcomposer.org/) for managing dependenci Appwrite is following the [PHP-FIG standards](https://www.php-fig.org/). Currently, we are using both PSR-0 and PSR-4 for coding standards and autoloading standards. Soon we will also review the project for support with PSR-12 (Extended Coding Style). -We use prettier for our JS coding standards and for auto-formatting our code. +We use prettier for our JS coding standards and auto-formatting our code. -## Scalability, Speed and Performance +## Scalability, Speed, and Performance Appwrite is built to scale. Please keep in mind that the Appwrite stack can run in different environments and different scales. @@ -216,7 +216,7 @@ For us to find the right balance, please open an issue explaining your ideas bef This will allow the Appwrite community to have sufficient discussion about the new feature value and how it fits in the product roadmap and vision. -This is also important for the Appwrite lead developers to be able to give technical input and different emphasize regarding the feature design and architecture. +This is also important for the Appwrite lead developers to be able to give technical input and different emphasis regarding the feature design and architecture. ## Build @@ -244,7 +244,7 @@ docker exec appwrite test ## Code Maintenance -We use some automation tools to help us keep a healthy code base. +We use some automation tools to help us keep a healthy codebase. Improve PHP exeution time by using [fully-qualified function calls](https://veewee.github.io/blog/optimizing-php-performance-by-fq-function-calls/): @@ -297,5 +297,5 @@ Submitting documentation updates, enhancements, designs, or bug fixes. Spelling ### Helping Someone -Searching for Appwrite on Discord, GitHub or StackOverflow and helping someone else who needs help. You can also help by reaching others how to contribute to Appwrite's repo! +Searching for Appwrite on Discord, GitHub, or StackOverflow and helping someone else who needs help. You can also help by reaching others how to contribute to Appwrite's repo!