CONTRIBUTING.md

Contribution Guide

Contribution to InvoicePlane

Every help is welcome, you don't have to be a professional PHP developer or SQL database engineer. If you are not familiar with PHP or coding in general you could also help us in other ways.

Helpful Links

Important information about Branches

• ⚠️ Never ever push any commits to the develop or master branches!
• Do not create a branch that contains any version numbers like 2.1.4.
• Want to create a new branch? Use the issue ID from the issue tracker for the branch name, e.g. IP2-39.
  There is no issue with your corresponding ticket? Create one please.

Contributing Code

⚠️ Read this carefully to prevent your pull request to be closed!

1. Before you submit any code to the repository please take a look at the development tracker and search for your issue!
   • If an issue exists and someone is working on it, please contact this person.
   • If an issue exists and no one is working on it, assign it to yourself or write a comment.
2. Always reference the issue ID (e.g. IP2-317) in all commits you make for this issue.
3. Before you create a pull request, rebase from the development branch.
   • Add the development branch as a remote: git remote add ip [email protected]:InvoicePlane/InvoicePlane.git
   • Do a rebase with the following command: git pull --rebase ip development Where ip is the name of the remote and development the branch.
   • Solve all conflicts and check if your code is still working.
4. Submit the pull request, reference the issue ID in the title and add a meaningful description.

---

Please notice: The name 'InvoicePlane' and the InvoicePlane logo are both copyright by Kovah.de and InvoicePlane.com and their usage is restricted! For more information visit invoiceplane.com/license-copyright