Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 947 Bytes

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 947 Bytes
Raw

Contributing

Contributing Code

  • Fork the repo.
  • Write your contribution.
  • Make sure your code follows our coding style (e.g.Python code should follow PEP8).
  • Run tests. For instance, if you are editing the server or the python client:
$ cd client/python
$ $PYTHON_VERSION -m unittest discover

  • Push to your fork. Write a good commit message. Submit a pull request (PR).

  • Wait for your PR to be reviewed by one of the maintainers.

Other details

Bumping versions

  • Edit the __VERSION__ variable in server code and clients.
  • Create a new rockspec:
$ luarocks new_version crayonx.x-1.rockspec y.y-1 \
      https://raw.githubusercontent.com/torrvision/crayon/<new_hash>/client/lua/crayon.lua
  • Commit your changes, and tag commit in the form of vy.y.
  • Push to master (so that CI will deploy to PyPI).