Code contribution policy.

Thank you for your interest in contributing to Sfdmu!

We welcome code contributions to Sfdmu.

The following is a set of guidelines and suggestions to make it easier for you to contribute to Sfdmu.

Please make them in the form of from your fork, and bear in mind the following guidelines and suggestions.

  • Before starting to work, make sure to check our issue tracker for tickets regarding your suggested change. It's possible someone could have already reported your bug or suggestion and it has been discussed it in detail.

    If you have any doubts about whether your changes will be accepted, contact us in advance to avoid unnecessary spending your time.

  • We can accept only small cosmetic direct adjustments of the Sfdmu core code. Any complex modifications must be implemented only using our Add-On Api Engine / Custom Sfdmu Add-On Api.

  • You can't propose any modification to the Add-On Engine itself, only a new core module based on the currently released API version, which module as you think may be helpful for other users as a part of the Sfdmu.

  • If you wish to extend the Sfdmu to make any specific job for any personal purpose, please implement your Custom Module and attach it locally on your side without opening a PR.

  • Each pull request should be submitted including the detailed description of the change you want to make.

  • Submit your pull request ONLY TO THE "CONTRIBUTION" BRANCH. Don't use any other branch for submitting your changes.
  • Your change MUST COMPLY with the LATEST SFDMU VERSION and should pass a validation without any code conflicts or other code problems.

  • Make sure YOU TESTED your code well before submitting the PR.

  • We can decline the PR if your code is not compatible with our code writing conventions or other reasons. We appreciate your understanding in the matter.

Last updated on Tu May 2022