Skip to content

Contributing to SED

Zain Sohail edited this page Feb 8, 2022 · 1 revision

If you would like to develop to improve or extend the funtionality of SED, there are certain criteria we would like to adhere to so as to keep the package maintainable and bugfree.

The codebase has this structure: [TBD]

Practices to follow before opening a pull request:

  • Using python type hints
  • Testing every method and common use cases
  • Using black to reformat the code
  • Documenting every method, class and module
  • Linking an issue or discussion with the pull request
  • Labeling the issue/disucssion with correct the tag
Clone this wiki locally