First off, thanks for contributing to this project, we appreciate all efforts made to help this project!
before you contribute please have a look at our Code-of-Conduct
If you would like to report a bug, or request a feature Open an issue, and select the appropriate template
please beware to not open a duplicate issue, please first search for the issue, of you didn't find any issue that like yours, feel free to open a new one.
If you would like to start contributing to the code, select an open issue, Start coding and open a pull-request
We'll use the standard python coding conventions, these could automatically be checked with Pylint, or Flake8 and even formatted with autopep8 or Black --> Alt + Shift + F is the standard shortcut for auto-formatting a whole document in Visual Studio Code
The branching strategy is quite simple, for each new pull request we'll use subject matter branches
as an example, for a bug fix we'll use the new branch Limitless-gaming-bugfix-<issue number> same with features, Limitless-gaming-feature-<issue number>. this way if someone want's to start working on a open issue, they can see what code is already present, if it is present.
There is a pull request template, this will ensure consistent and complete pull requests. If something isn't clear or a PR is taking to long to review, please let us know ASAP.
There is also a small commit template, to use the commit template execute the following command:
git config commit.template ./docs/.commit-template, for more info have a look into the file itself
please also try not to bulk commit files (commit a large set of files which you have worked on)
please try committing them as smaller logical groups.
We'll use the standard python unittest module, it very well documented, and pretty easy in use. for a simple example have a look at the example test, the name of a test should always follow the following format -> *_test.py, e.g. example_test.py or main_test.py.
For more info about how to write and execute test see How-to-test
if a test needs a input, or stream try to simulate it with a file. please provide the file in the assets folder, with the corresponding test