Skip to content

Pull Request Requirements

Keenan Lang edited this page Sep 15, 2016 · 1 revision

Pull Request Requirements

In order to help out the synApps developers with accepting your changes, please try to include the following information with your pull request.


For bug fixes or reporting issues, you should include:

  • Information about your build environment

    • Build Arch
    • Version of Base you are using
    • Version of dependent synApps modules you are using
  • Information about the issue

    • A description of what is considered wrong
    • Any error messages received
    • Any bug fix pull request should include a link a relevant issue or a description of what problem the bug fix is trying to solve and why it needs to be fixed.

When adding features, you should include:

  • Documentation about the feature

    • This isn't necessary to put in the pull request if it is adequately documented in the commit itself.
    • Description of changes, what support is being added or if support is being modified, why is this change useful?
    • Information about parameters of any functions added
    • Information about necessary macros for databases added
  • Testing Information

    • Has this feature been tested?
    • If so, What was the build environment and relevant settings used to test?
    • If no ioc startup command file is included with the commit, post a snippet of code that adequately demonstrates the functionality.