Skip to content

Contributing: code

The community can contribute to Squest by providing some new features, bug fix and enhancements.

How to contribute

  1. Fork it!
  2. Checkout the dev branch git checkout dev
  3. Create your feature branch: git checkout -b my-new-feature
  4. Commit your changes: git commit -am 'Add some feature'
  5. Push to the branch: git push origin my-new-feature
  6. Submit a pull request in the dev branch

If you are new on Github environment, we recommend you to read the first contribution guide.

Follow the development environment setup documentation to prepare your workstation with prerequisites.

Constraints

Respect PEP 257 -- Docstring conventions. For each class or method add a description with summary, input parameter, returned parameter, type of parameter

def my_method(my_parameter):
    """
    Description of he method
    :param my_parameter: description of he parameter
    :type my_parameter: str
    """
    pass

Respect PEP 8 -- Style Guide for Python Code We recommend the usage of an IDE like Pycharm