Guidelines

Guidelines

Reporting Bugs

Make sure you have the latest version of Photon with all the dependencies installed. Please follow the following layout while starting an issue for a bug:

Title

Description

Include brief description of the bug.

Output

Attach screenshots of the error or paste the output here.

Platform

os: <operating system>
python: <python version>

Steps to reproduce

This section should describe how to reproduce the bug.

Potential cause & fix

If you know what is causing the error or how to fix this please include that information in this section.

Pull Requests

Pull requests regarding things which aren't directly related to the program will not be merged.

For example, pull requests related to README.md, .travis.yml and .gitignore will not be merged, you can open an issue instead.

While adding a new command line argument, please keep in mind that shorthand aliases e.g. -t are only for arguments which require an additional value.

For example, if you want to add an argument that disables colors in output you should use something like --disable-colors instead of -c.

If you need to import a new non-standard library, add it to requirements.txt.

Mention the changes in changes variable in photon.py.

Please follow the following layout while submitting a pull request.

Title

Description

Include a brief description of what is it all about.

Tested on

os: <operating system>
python: <python version(s)>

Dependencies

Mention new dependencies, if any.