Skip to content

For Developers

Pinaki Mondal edited this page Jan 30, 2021 · 3 revisions

Before continuing any further, let me thank you for your interest in contributing to SIPTorch. Open-source thrives on these community contributions!

Contributing

You pull request must be satisfying at least one of these categories:

  • A new feature/enhancement.
  • Fix an issue/feature-request.
  • An improvement to existing modules.

Pull requests other than these (eg. adding a new banner or word corrections) will NOT be entertained.

Few Tips

The following points are to be kept in mind when contributing to this repository:

  • The code should be licensed under the same GPL v3 License.
  • The code should be well documented so that folks will know what's going on under the hood.
  • Please specify the Operating System and Python environment to make your pull request reproducible.
  • Do refer whether your code adds any new dependency or not.
  • Mention whether the new PR does add any new parameters to the existing set.
  • Always test your build before sending the PR.
Clone this wiki locally