Contributing Guide

Thank you for investing your time in contributing to PyLoan! In this guide you will get an overview of the contribution workflow from opening an issue, creating a pull request, reviewing and merging the pull request.

Issues

Create a New Issue

If you spot a problem with the docs, search if an issue already exists. IF a related issue deos not exist, your can open a new issue using a relevant issue form.

Solve an Issue

Scan through the existing issues to find on that interests you. If you find an issue to work on, you are welcome to open a pull request with a fix.

Make Changes

To contribute to PyLoan, fork the respository. Afterward, create a working branch and start with your changes. Commit the changes once you are happy with them.

Pull Request

When you are done with the changes, create a pull request.

Fill the “Ready for Review” template so that we can review your pull request. This template helps reviewers understand your changes as well as the purpose of your pull request.
Do not forget to link pull requst to issue if you are solving one.
Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your pull request, we will review your proposal, We may ask questions or request for additional information.
We may ask for changes to be made fore a pull request can be merged, either using suggested changes or pull request comments.
As you update your pull request, mark each conversation as resolved.
If you run into any merge issues, please resolve merge conflicts and other issues.