CONTRIBUTING.md

Contributing to Invoice Ninja

Thanks for your contributions!

Submit bug reports or feature requests

Please discuss the changes with us ahead of time to ensure they will be merged.

Submit pull requests

• Fork the Invoice Ninja repository
• Create a new branch with the name #issue_number-Short-description
  • Example: #100-Add-GoogleAnalytics
• Make your changes and commit
• Check if your branch is still in sync with the repositorys develop branch
  • Read: Syncing a fork
  • Also read: How to rebase a pull request
• Push your branch and create a PR against the Invoice Ninja develop branch
• Update the Changelog

Some rules

To make the contribution process nice and easy for anyone, please follow some rules:

• Each contribution(bug or feature) should have an issue on Github to give a more detailed explanation.
• Only one feature/bugfix per issue. If you want to submit more, create multiple issues.
• Only one feature/bugfix per PR(pull request). Split more changes into multiple PRs.

Coding Style

Try to follow the PSR-2 guidlines

Example styling:

/**
 * Gets a preview of the email
 *
 * @param TemplateService $templateService
 *
 * @return \Illuminate\Http\Response
 */
public function previewEmail(TemplateService $templateService)
{
    //
}

Translations

For helping us with translating Invoice Ninja, please use Transifex.