Before sending your pull requests, make sure you followed this list.
- Read contributing guidelines.
- Read Code of Conduct.
- Changes are consistent with the coding style.
- Run unit tests.
If you have improvements to Football Data Connector, send your pull requests! For those just getting started, Github has a howto.
Include a license at the top of new files.
Refer PEP-8 here
Refer docstring conventions here
Use pylint to check your Python changes.
Development environment may need additional packages such as pylint, sphinx
etc. These dependencies are included in the requrements.txt file. To install
these, run the following command:
pip install -r requirements.txt
Using a virtual environment is recommended.
Football data connector uses python's built in unittest framework. To run the test cases, use the following command:
python -m unittestFootball data connector uses restructured text for documentation files and sphinx to build the documentation. If you haven't updated the documentation, please mention that in the pull request. This will help someone else to complete the documentation before releasing new versions.