diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d55190a..c5b490b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,17 +4,19 @@ ## Table of Contents -- [Introduction](#introduction) -- [Reporting Bugs](#reporting-bugs) -- [Style Guide](#style-guide) - - [Git Commit Messages](#git-commit-messages) - - [Python Style Guide](#python-style-guide) - - [Documentation](#documentation) -- [Contributing](#contributing) +- [Table of Contents](#table-of-contents) + - [Introduction](#introduction) + - [Reporting Bugs](#reporting-bugs) + - [How to report bugs](#how-to-report-bugs) + - [Style Guide](#style-guide) + - [Git Commit Messages](#git-commit-messages) + - [Python Style Guide](#python-style-guide) + - [Documentation](#documentation) + - [Contributing](#contributing) ## Introduction -First of all we are happy you are to contribute to Chapa. We are always looking for new features and improvements. If you have any suggestions, please let us know. We will be happy to hear from you. Fork the project on [Github](https://github.com/chapimenge3/chapa) and open an issue or a pull request. +First of all, we are happy you are to contribute to Chapa. We are always looking for new features and improvements. If you have any suggestions, please let us know. We will be happy to hear from you. Fork the project on [Github](https://github.com/chapimenge3/chapa) and open an issue or a pull request. ## Reporting Bugs @@ -22,9 +24,9 @@ First of all we are happy you are to contribute to Chapa. We are always looking This section is for reporting bugs. Please make sure to include the following: - - Describe the exact Steps to reproduce the bug - - Describe the Expected behavior - - Describe the Actual behavior + - Describe the exact steps to reproduce the bug + - Describe the expected behavior + - Describe the actual behavior - Describe the parameter data that you are passing to the API - Use a clear and descriptive title - Add bug tag to the issue @@ -35,7 +37,7 @@ So in this section we will see the style guide for the project. ### Git Commit Messages -For Git commit conventions, please follow the [Git Commit Conventions](https://www.conventionalcommits.org) and follow the [Github Likning PR to Issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) +For Git commit conventions, please follow the [Git Commit Conventions](https://www.conventionalcommits.org) and follow the [Github Linking PR to Issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) ### Python Style Guide @@ -47,8 +49,8 @@ For documentation, please make sure your documentation is clear and concise. Pro Give examples of how to use the function. Put the expected behavior in the description. -You can make it interative by adding emojis💯, GIFs, videos and etc. +You can make it interactive by adding emojis💯, GIFs, videos and etc. ### Contributing -Creating PR is the best way to contribute to the project. The PR should be clear and concise. The Linting Should be passed. The PR should be well written. We have prepared PR template for you. Please follow the template. +Creating PR is the best way to contribute to the project. The PR should be clear and concise. The Linting Should be passed. The PR should be well written. We have prepared a PR template for you. Please follow the template. diff --git a/README.md b/README.md index e61ecfb..2353c44 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ data = { 'amount': 1000, 'first_name': 'Abebe', 'last_name': 'Bikila', - 'tx_ref': '', + 'tx_ref': '', # optional 'redirect_url': 'https://www.your-site.com/callback', 'customization': { @@ -43,16 +43,16 @@ print(response['data']['checkout_url']) chapa = Chapa('', response_format='obj') response = chapa.initialize(**data) # notice how the response is an object -print(reponse.data.checkout_url) +print(response.data.checkout_url) # How to verify a transaction -response = chapa.verify('') +response = chapa.verify('') ``` ## Contributing -Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. After that free to contribute to this project. Please Read the [CONTRIBUTING.md](https://github.com/chapimenge3/chapa) file for more information. +Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. After that free to contribute to this project. Please read the [CONTRIBUTING.md](https://github.com/chapimenge3/chapa/blob/main/CONTRIBUTING.md) file for more information. Please make sure to update tests as appropriate. @@ -76,7 +76,7 @@ Base endpoint https://api.chapa.co/v1 | `tx_ref` | `string` | **Required**. A unique reference given to each transaction. | | `currency` | `string` | **Required**. The currency in which all the charges are made. Currency allowed is ETB. | | `redirect_url` | `string` | The URL to redirect the customer to after payment is done. | -| `customization[tiitle]` | `string` | The customizations field (optional) allows you to customize the look and feel of the payment modal. You can set a logo, the store name to be displayed (title), and a description for the payment. | +| `customization[title]` | `string` | The customizations field (optional) allows you to customize the look and feel of the payment modal. You can set a logo, the store name to be displayed (title), and a description for the payment. | | HEADER Key | Value | | :-------------- | :---------------------- |