Skip to content

Latest commit

 

History

History
45 lines (33 loc) · 1.83 KB

CONTRIBUTING.rst

File metadata and controls

45 lines (33 loc) · 1.83 KB

Ultimate TicTacToe - Python Player & Game Engine - Contribution Guide

Pull Requests

To make a contribution, please fork this repository and open a pull request. We are grateful for anything that can be improved for the students taking part in our hackathons.

In general, any new functionality or player should be tested to ensure it is behaving as expected.

Running Tests

You (and Travis CI) can ensure our tests pass by running ./setup.py test in the root directory. Keep it that way!

Pushing New Versions

To push a new version:

  1. Update the version string and download_url in the setup.py file to the new version
  2. Update the documentation
    1. cd docs
    2. sphinx-apidoc -o source/ ../engine
    3. make html
  3. Create a git tag for the new version and push that
  4. Upload to PyPI: #. python setup.py sdist upload -r pypi