Skip to content

Latest commit

 

History

History
executable file
·
37 lines (30 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
37 lines (30 loc) · 2.51 KB
Raw

#How to Contribute

Already a PHP Developer? Familiar with Symfony, DDD, Event Sourcing and/or CQRS? Pick an issue, push a PR and instantly become a member of the Open Loyalty contributors community.

Thank you for your interest in, and engagement with, the Open Loyalty community. We intend to provide this solution for companies and developers willing to build great loyalty applications all over the world and would like to encourage you to join us in creating the best open source platform for this purpose.

Before you type an issue please check:

Issue reporting guidelines:

  • Always define type of issue:
    • Bug report
    • Feature request
  • While writing issues, be as specific as possible
  • All requests regarding support with implementation or application setup should be sent to support@openloyalty.io

Here’s how to submit a pull request:

  • Fork the repository and clone it locally. Connect your local repository to the original “upstream” repository by adding it as a remote repository. Pull in changes from “upstream” often in order to stay up to date so that when you submit your pull request, merge conflicts will be less likely.
  • Create a branch for your edits. Use the following branch naming conventions:
    • bugfix/task-title
    • feature/task-name
  • Reference any relevant issues or supporting documentation in your PR (ex. “OLOY: 39. Issue title.”).
  • Include screenshots of the before and after if your changes include differences in HTML/CSS. Drag and drop the images into the body of your pull request.
  • Test your changes! Run your changes against any existing tests and create new ones when needed. Make sure your changes don’t break the existing project.
  • Contribute in the style of the project and follow the coding standards https://symfony.com/doc/current/contributing/code/standards.html
  • Check build status on Travis. It always should be green.

Reporting Potential Security Issues

If you have found a potential security vulnerability, please DO NOT report it on the public issue tracker. Instead, send it to us at security@openloyalty.io. We will work with you to verify and fix it as soon as possible.

Please provide the following information:

  • Bundle(s) affected
  • Description of how to reproduce the issue
  • The impact on the application
  • If possible, an idea how to fix the vulnerability.