Code contribution policy.
Thank You for Your Interest in Contributing to SFDMU!
We greatly appreciate your willingness to contribute code to SFDMU. To streamline the process and make your contributions as efficient as possible, please follow these guidelines:
Check Existing Issues: Before starting work, review our issue tracker to see if your bug or suggestion has already been reported or discussed. If you're unsure about whether your changes will be accepted, please contact us beforehand to avoid unnecessary effort.
Scope of Changes: We primarily accept minor, cosmetic modifications to the core SFDMU code. For more complex enhancements that might benefit other users, please share your ideas with us first. Depending on the proposal, we may update the SFDMU Core or develop a new Core Add-On Module using our Add-On API Engine.
Custom Add-Ons: If you need a specific feature for your own business, consider developing a Custom Add-On Module and maintaining it locally without submitting a pull request (PR).
Submitting Pull Requests:
- Create a fork of the repository and make your changes.
- Start with a new feature branch off the "master" branch for your PR.
- Include a detailed description of your changes in the PR.
- Ensure your code is compatible with the latest SFDMU version and passes all validations without conflicts.
- Write your code in the same coding style as the existing codebase.
- Keep your code concise and efficient wherever possible.
- Thoroughly test your code before submitting the PR. You don't need to write unit tests; instead, test your code by running a real migration job in debug mode to ensure it resolves the desired issue without introducing regressions.
For more guidance on creating pull requests from forked repositories, please see How to Create Pull Requests.