Skip to content
This repository has been archived by the owner on Apr 18, 2024. It is now read-only.

Contribution

Pavel Skipenes edited this page Aug 24, 2022 · 7 revisions

Building the project

First of all make sure you can build the entire project. Follow the steps described in getting started. If you get error messages, create a new issue that describes the problem. Add the label installation. Include as many log files as you can.

Working with git

Learn how to use git. Recommending watching git schooldude on youtube. And then follow commit and branch guidelines. Here is an example. There are many guidelines and none are the same but just following some kind of system is better than committing random messages. Also it help when you don't know what to write in the commit message.

When you're happy with your changes take a look at git diff and git stage related changes in one commit. If you use VS Code as an IDE you can stage a part of a file. Select those lines you want to commit and press Ctrl + Shift + P and then select Git: stage selected ranges. When you've commited all changes you can push it to remote. Test the changes in test server (TODO: link to how to set up a test server). If your changes work as expected in test server make a pull request.

the stack

How to find work

finding issues

find good first issues , assign your self to it. Create a new branch, implement the fix and create a PR to master branch.

Finding problems in source code

Just search for TODO FIXME or BUG in the project source files. The easiest problems is to update documentation and these wiki pages.

Understanding the project

Project is quite complex. Here are some tutorials that you should read and understand:

There are three payment methods in Stripe when using card payments. Traditional authentication flow, Secure 3D version 1 and Secure 3D version 2. This project supports all of those. Stripe test API is not connected to banking network so regular credit cards would not work. Use test cards. Testing with live cards in production is not allowed by Stripe.