Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

51 lines (32 loc) · 1.44 KB

Contributing to IPpy

Contributor Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Workflow

  • Fork the project.
  • Make your bug fix or feature addition.
  • Add tests for it. This is important so we don't break it in a future version unintentionally.
  • Send a pull request to the develop branch.

Please make sure that you have set up your user name and email address for use with Git. Strings such as silly nick name <root@localhost> look really stupid in the commit history of a project.

Due to time constraints, you may not always get a quick responce. Please do not take delays personal and feel free to remind me.

Using IPpy from a Git checkout

The following commands can be used to perform the initial checkout of ippy:

$ git clone https://github.com/shivammathur/ippy.git

$ cd ippy

Install IPpy manually

$ python setup.py install

Using IPpy using PyPI

pip install ippy

Running the test suite

After following the steps shown above, The tox tests in the tests directory can be run using this command:

$ tox

Reporting issues

Please submit the issue using the appropiate template provided for a bug report or a feature request: