From 38803976f47f3a3fd1d53a3ac18a2d937f0c9881 Mon Sep 17 00:00:00 2001 From: arpitpandey0209 Date: Wed, 1 Nov 2023 01:58:52 +0530 Subject: [PATCH] docs: fix grammar issues and typos --- .github/PULL_REQUEST_TEMPLATE/pull_request_template.md | 2 +- .idea/runConfigurations.xml | 10 ++++++++++ submissions/Chisend/README.md | 2 +- submissions/GetStarted/Blogs.html | 2 +- submissions/chiconnect-bank-api-payout/README.md | 2 +- submissions/chiconnect-giftcard-payout/README.md | 2 +- submissions/chiconnect-mobile-money-payout/README.md | 2 +- submissions/chimap/README.md | 2 +- submissions/chimoney-discord-bot/readme.md | 2 +- submissions/chimoney-github-bot/README.md | 2 +- submissions/chimoney-payout-airtime/README.md | 2 +- submissions/chimoney-redeem-airtime/README.md | 4 ++-- submissions/pay-paddy/README.md | 2 +- submissions/whatsapp-bot-node/readme.md | 2 +- 14 files changed, 24 insertions(+), 14 deletions(-) create mode 100644 .idea/runConfigurations.xml diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 81b27fb0..747c4e9f 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -21,5 +21,5 @@ - [ ] I have added/updated relevant documentation/screenshots (if applicable). - [ ] I have included tests (if applicable). - [ ] I have labeled the PR appropriately with `Feature`, `Improvement`, `Bug` or `New Project` -- [ ] My branch is up to date with the main branch. +- [ ] My branch is up-to-date with the main branch. - [ ] The PR has a meaningful title and description. diff --git a/.idea/runConfigurations.xml b/.idea/runConfigurations.xml new file mode 100644 index 00000000..797acea5 --- /dev/null +++ b/.idea/runConfigurations.xml @@ -0,0 +1,10 @@ + + + + + + \ No newline at end of file diff --git a/submissions/Chisend/README.md b/submissions/Chisend/README.md index 12cf04c4..cc68d7bc 100644 --- a/submissions/Chisend/README.md +++ b/submissions/Chisend/README.md @@ -14,7 +14,7 @@ The bot is written in Python and uses the [Tweepy](https://www.tweepy.org/) libr It uses the pychimoney library to send the chimoney. ## How to use -- Follow the bot on twitter +- Follow the bot on Twitter - Tweet the bot with the following format - @chisendtest send amount to @username - The bot will you a direct message for confirmation and checkout diff --git a/submissions/GetStarted/Blogs.html b/submissions/GetStarted/Blogs.html index dd019c93..2b6b1e47 100644 --- a/submissions/GetStarted/Blogs.html +++ b/submissions/GetStarted/Blogs.html @@ -122,7 +122,7 @@

introduction to Chimoney

method

Endpoints:

Get list of all supported airtime Countries.

https://api.chimoney.io/v0.2/info/airtime-countries
-

Get list of all assests.

https://api.chimoney.io/v0.2/info/assets
+

Get list of all assets.

https://api.chimoney.io/v0.2/info/assets

Get list of Supported banks and bank code.

https://api.chimoney.io/v0.2/info/country-banks

Get list of bank branches and branch code.

https://api.chimoney.io/v0.2/info/bank-branches

get exchange rates.

https://api.chimoney.io/v0.2/info/exchange-rates
diff --git a/submissions/chiconnect-bank-api-payout/README.md b/submissions/chiconnect-bank-api-payout/README.md index c6ded19c..ffd6f2ef 100644 --- a/submissions/chiconnect-bank-api-payout/README.md +++ b/submissions/chiconnect-bank-api-payout/README.md @@ -10,7 +10,7 @@ A mini project to demonstrate integration of Chiconnect bank api payout using Re ## Commit style guidelines -A commit message should easily convey what it contains so this guidelines shows a commit should be for this project. +A commit message should easily convey what it contains so the guidelines show a commit should be for this project. The commit message should be in this format `type: subject` where `type` can be any one of these: diff --git a/submissions/chiconnect-giftcard-payout/README.md b/submissions/chiconnect-giftcard-payout/README.md index 10d8b15d..08491c0b 100644 --- a/submissions/chiconnect-giftcard-payout/README.md +++ b/submissions/chiconnect-giftcard-payout/README.md @@ -10,7 +10,7 @@ A mini project to demonstrate integration of Chiconnect giftcard payout using Re ## Commit style guidelines -A commit message should easily convey what it contains so this guidelines shows a commit should be for this project. +A commit message should easily convey what it contains so the guidelines show a commit should be for this project. The commit message should be in this format `type: subject` where `type` can be any one of these: diff --git a/submissions/chiconnect-mobile-money-payout/README.md b/submissions/chiconnect-mobile-money-payout/README.md index 07f1e0ca..5cf71727 100644 --- a/submissions/chiconnect-mobile-money-payout/README.md +++ b/submissions/chiconnect-mobile-money-payout/README.md @@ -13,7 +13,7 @@ A mini project to demonstrate integration of Chiconnect mobile money api payout ## Commit style guidelines -A commit message should easily convey what it contains so this guidelines shows a commit should be for this project. +A commit message should easily convey what it contains so the guidelines show a commit should be for this project. The commit message should be in this format `type: subject` where `type` can be any one of these: diff --git a/submissions/chimap/README.md b/submissions/chimap/README.md index 767a1b9b..23f10edd 100644 --- a/submissions/chimap/README.md +++ b/submissions/chimap/README.md @@ -13,7 +13,7 @@ Run development server: npm run dev ``` -## Enviroment Variables +## Environment Variables For development server, create file ".env.local" in project root folder and add the following NEXT_PUBLIC_MAPBOX_KEY diff --git a/submissions/chimoney-discord-bot/readme.md b/submissions/chimoney-discord-bot/readme.md index b12fc834..d90724c5 100644 --- a/submissions/chimoney-discord-bot/readme.md +++ b/submissions/chimoney-discord-bot/readme.md @@ -27,7 +27,7 @@ The /send_chimoney command sends X amount of funds to Y user ## Deployment -The Chimoney bot is current hosted on a heroku server, however this poses some issues +The Chimoney bot is currently hosted on a heroku server, however this poses some issues as heroku's web processes timeout after a few minutes of inactivity. The bot cannot be deployed on a heroku worker as it uses a http server to listen for webhook events. diff --git a/submissions/chimoney-github-bot/README.md b/submissions/chimoney-github-bot/README.md index 192309fd..c932ce96 100644 --- a/submissions/chimoney-github-bot/README.md +++ b/submissions/chimoney-github-bot/README.md @@ -1,6 +1,6 @@ # chimoney-github-bot -> A GitHub App built with [Probot](https://github.com/probot/probot) that facilitates sponsoring github contributors using the chimoney API +> A GitHub App built with [Probot](https://github.com/probot/probot) that facilitates sponsoring GitHub contributors using the chimoney API ## Setup diff --git a/submissions/chimoney-payout-airtime/README.md b/submissions/chimoney-payout-airtime/README.md index 3bc7c0d2..b8cfecdd 100644 --- a/submissions/chimoney-payout-airtime/README.md +++ b/submissions/chimoney-payout-airtime/README.md @@ -13,7 +13,7 @@ Run the following commands in the project directory Runs the app in the development mode.\ Open [http://localhost:3000](http://localhost:3000) to view it in your browser. -## Screenshots of the the project +## Screenshots of the project screenshot screenshot diff --git a/submissions/chimoney-redeem-airtime/README.md b/submissions/chimoney-redeem-airtime/README.md index 72bf8bd1..a5dc4061 100644 --- a/submissions/chimoney-redeem-airtime/README.md +++ b/submissions/chimoney-redeem-airtime/README.md @@ -14,12 +14,12 @@ Runs the app in the development mode.\ Open [http://localhost:3000](http://localhost:3000) to view it in your browser. -## Screenshots of the the project +## Screenshots of the project screenshot screenshot -## Screenshots of the the Redeemed Airtime +## Screenshots of the Redeemed Airtime text-message text-message diff --git a/submissions/pay-paddy/README.md b/submissions/pay-paddy/README.md index 63523aa9..fd7a148b 100644 --- a/submissions/pay-paddy/README.md +++ b/submissions/pay-paddy/README.md @@ -31,7 +31,7 @@ React web app that utilizes most of Chiconnect api endpoints to enable a variety ## Commit style guidelines -A commit message should easily convey what it contains so this guidelines shows a commit should be for this project. +A commit message should easily convey what it contains so the guidelines show a commit should be for this project. The commit message should be in this format `type: subject` where `type` can be any one of these: diff --git a/submissions/whatsapp-bot-node/readme.md b/submissions/whatsapp-bot-node/readme.md index a5dc8cc2..f657bc31 100644 --- a/submissions/whatsapp-bot-node/readme.md +++ b/submissions/whatsapp-bot-node/readme.md @@ -49,4 +49,4 @@ Replace `@username` with the recipient's Telegram username and `amount` with the ### Receiving Chimoney -When you receive Chimoney, the bot will send recipient a mesage with a link to claim the Chimoney. +When you receive Chimoney, the bot will send recipient a message with a link to claim the Chimoney.