speedtest-cli/CONTRIBUTING.md

32 lines
1.1 KiB
Markdown
Raw Normal View History

2014-02-08 17:05:10 +01:00
# Pull Requests
2014-04-23 17:24:31 +02:00
## Pull requests should be
1. Made against the `devel` branch.
1. Made from a git feature branch.
## Pull requests will not be accepted that
2014-04-17 17:22:05 +02:00
1. Are not made against the `devel` branch
1. Are submitted from a branch named `devel`
2014-04-23 17:24:31 +02:00
1. Do not pass pep8/pyflakes/flake8
2014-04-17 17:22:05 +02:00
1. Do not work with Python 2.4-3.4 or pypy
1. Add python modules not included with the Python standard library
2014-04-23 17:24:31 +02:00
1. Are made by editing files via the GitHub website
2014-02-08 17:05:10 +01:00
# Coding Guidelines
2014-04-17 17:22:05 +02:00
In general, I follow strict pep8 and pyflakes. All code must pass these tests. Since we support python 2.4-3.4 and pypy, pyflakes reports unknown names in python 3. pyflakes is run in python 2.7 only in my tests.
2014-02-08 17:05:10 +01:00
# Supported Python Versions
2014-04-17 17:22:05 +02:00
All code needs to support Python 2.4-3.4 and pypy.
2014-02-08 17:05:10 +01:00
2014-02-09 01:18:34 +01:00
# Permitted Python Modules
Only modules included in the standard library are permitted for use in this application. This application should not be dependent on any 3rd party modules that would need to be installed external to just Python itself.
2014-02-08 17:05:10 +01:00
# Testing
Currently there are no unit tests, but they are planned.