Skip to content

Latest commit

 

History

History
35 lines (29 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

35 lines (29 loc) · 2.26 KB

Contributing to the product

Contributions to this project are welcome. Please follow the procedures outlined below.

Raising issues/tickets

Please use the below templates when you want to:

Please ensure that the tickets have appropriate labels and milestones.

Making a contribution by a team member

  • Create a new branch from testing and name it according to the ticket type and number. Example: feature_58 or bug_59. Ensure to follow branching guidelines.
  • Ensure to follow SemVer for versioning.
  • Ensure the directory structure is followed.
  • Ensure that python codes follow PEP 8 standards.
  • Ensure that codes are properly documented in accordance to PEP 257 standards.
  • Ensure function annotations are followed in accordance to PEP 484 standards.
  • Ensure all python modules have a Pylint rating of 10/10.
  • Ensure to profile your modules and move any bottlenecks to a low latency system/module.
  • Ensure to add unit tests with corner cases and achieve 100% code coverage.
  • Limit the use of third party libraries. If you do have to use them, ensure that it exists in production environment.
  • Follow pull request guidelines.

Guidelines

  1. Be respectful. All contributions to the product are appreciated and we ask that you respect one another.
  2. Be responsible. You are responsible for your pull request submission.
  3. Give credit. Any submissions or contributions built on other work (including and not limited to research papers, open source projects, and public code) must be cited with original Author names or attached with information about the original source or work. People should be credited for the work they have done.

Return to Home