4. Contributing

4.1. License

By contributing to this repository/project you are licensing your contributions under MIT license.

4.2. Coding Guidelines

  • Limit characters to 79 characters per line

  • Add one empty line at the end of a file (POSIX 3.206 Line)

  • python files must follow the rules defined in pyproject.toml and .pylintrc

  • python files must have the following header

    1
2
3
4
    #!/usr/bin/env python
# encoding: utf-8

# SPDX-License-Identifier: MIT

  • lua files must have the following header

    1
2
3
    #!/usr/bin/env lua

-- SPDX-License-Identifier: MIT

  • C/C++ files must have the following header

    1
    /* SPDX-License-Identifier: MIT */