Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typo fix #2

Merged
merged 5 commits into from
Jun 1, 2022
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 17 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,30 @@

## 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)
- [Contributing to Chapa](#contributing-to-chapa)
- [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

### How to report bugs

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
Expand All @@ -35,7 +38,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

Expand All @@ -47,8 +50,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.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ data = {
'amount': 1000,
'first_name': 'Abebe',
'last_name': 'Bikila',
'tx_ref': '<your-unique-transation-id>',
'tx_ref': '<your-unique-translation-id>',
chapimenge3 marked this conversation as resolved.
Show resolved Hide resolved
# optional
'redirect_url': 'https://www.your-site.com/callback',
'customization': {
Expand All @@ -43,16 +43,16 @@ print(response['data']['checkout_url'])
chapa = Chapa('<your_api_key>', 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('<your-unique-transation-id>')
response = chapa.verify('<your-unique-translation-id>')
chapimenge3 marked this conversation as resolved.
Show resolved Hide resolved
```

## 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.

Expand All @@ -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 |
| :-------------- | :---------------------- |
Expand Down