Skip to content

Commit 3e5f794

Browse files
add readme introduction and contributing guide
1 parent ed763c4 commit 3e5f794

File tree

2 files changed

+39
-1
lines changed

2 files changed

+39
-1
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
### How to contribute to the bunq Python SDK 😎
2+
3+
#### Want to add a new amazing feature to our SDK? 🚀
4+
- First let’s discuss the feature that you would like to add. [Open a new issue](https://github.com/bunq/bunq-Python/issues/new), describe the feature and explain why you think it should be added.
5+
- Once we agree on the new feature, open a new GitHub pull request and include all the relevant information to get your code approved!
6+
7+
#### Did you find a bug? 🐛
8+
- Before opening a new issue check if the bug hasn't already been reported by searching on GitHub under [issues](https://github.com/bunq/bunq-Python/issues).
9+
- If it hasn't already been reported you can [open a new issue](https://github.com/bunq/bunq-Python/issues/new). Make sure you include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behaviour that is not occurring.
10+
- If you wrote a patch that fixes a bug, open a new GitHub pull request and make sure to clearly describe the problem and your awesome solution.
11+
12+
#### Do you have questions about the source code?
13+
- You are welcome to ask whatever you want about the bunq Python SDK on [Together](https://together.bunq.com) 🎤
14+
15+
#### Are you looking for a challenging new adventure?
16+
- We're always looking for the best developers to come and join us at the Bank of the Free! 🌈 [Check out our vacancies](https://www.bunq.com/en/jobs)!
17+
18+
Thanks, and have fun! 💪

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
1-
# bunq Java SDK
1+
# bunq Python SDK
22
Version 0.9.0 **BETA**
33

4+
## Introduction
5+
Hi developers!
6+
7+
Welcome to the bunq Python SDK! 👨‍💻
8+
9+
We're very happy to introduce yet another unique product: complete banking SDKs!
10+
Now you can build even bigger and better apps and integrate them with your bank of the free! 🌈
11+
12+
Before you dive into this brand new SDK, please consider:
13+
- Checking out our new developer’s page [bunq.com/developers](https://bunq.com/developers) 🙌
14+
- Grabbing your production API key from the bunq app or asking our support for a Sandbox API key 🗝
15+
- Visiting [together.bunq.com](https://together.bunq.com) where you can share your creations,
16+
questions and experience 🎤
17+
18+
Give us your feedback, create pull requests, build your very own bunq apps and most importantly:
19+
have fun! 💪
20+
21+
This SDK is in **beta**. We cannot guarantee constant availability or stability.
22+
Thanks to your feedback we will make improvements on it.
23+
424
## Installation
525
In the root of your project, being in the correct virtual environment, run:
626
```shell

0 commit comments

Comments
 (0)