Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1.89 KB

contributing.md

File metadata and controls

32 lines (21 loc) · 1.89 KB

CONTRIBUTING

You're welcomed here to contribute to this repo. However, several important rules and notices should be respected

  • Everything should on the right place

    Just to keep things ORGANIZED please everyone place right things at right places

    • JSON Storyline files should be placed in story/storyline name folder.
    • Except from the main.py file, all other codes should be put into codes folder.
    • Tutuorials and introductions on your storyline should be placed in etc/your storyline name folder.
    • Explaination about codes should be put in the SOURCE CODE FILE directly as comments.
    • The main folder shall not be changed.

  • Codes should be reasonable

    Nope, no pytorch here

    • References to a new library without clear reason could cause your pull request being refused. e.g. using pytorch just for fun is not allowed. However, using new library for adding new features, clean codes and other reasonable things is allowed.
    • Comment-less codes are just garbage. Commit Anything with huge chunks of codes without comments is not allowed.
    • Public Repos are not for you to show-off, test and mess around. Please keep codes at a Resonable Complexity. Also, although we encourage the usage of new features, please do not use DRAFT-LEVEL FEATURES
    • New codes should be published to your own branch instead of main

  • Issues

    • You're welcomed to open a issue here for any problem that YOU CANNOT FIND A SOLUTION, search the web before you ask.
    • Codes should run anyway on most platforms, they're tested on Ubuntu, Windows and MacOS
    • They may have bugs, you can always open an issue/pull request on it.
    • Running on Non-Offical python interpreter may cause problems and you need to figure it out yourself. For example, python implentations on iOS or Android.

  • Be Respect