Skip to content

Latest commit

 

History

History
62 lines (36 loc) · 2.66 KB

CONTRIBUTING.rst

File metadata and controls

62 lines (36 loc) · 2.66 KB
Raw

Contributing

We want to start by thanking you for using Jupyter-gmaps. We very much appreciate all of the users who catch bugs, contribute enhancements and features or add to the documentation. Every contribution is meaningful, so thank you for participating.

How to contribute

Code contributions are more than welcome. Take a look at the issue tracker, specially issues labelled as beginner-friendly. These are issues which have a lot of impact on the project, but don't require understanding the entire codebase.

Beyond code, the following contributions will make gmaps a better project:

  • additional datasets related to geographical data. The data needs to be clean, of reasonable size (ideally not more than 1MB), and should be clearly related to geography.
  • additional GeoJSON geometries. These should be clean and reasonably small (ideally 1-3MB).
  • Examples of you using Jupyter-gmaps. If you've used gmaps and have an artefact to show for it (a blogpost or an image), I'm very happy to put a link in the documentation.

Installing a development version of gmaps

You must have NPM to install the development version. You can install NPM with your package manager.

You must also install gmaps in a virtual environment (or, at least, you must be able to run pip without root access).

Clone the git repository by running:

$ git clone https://github.com/pbugnion/gmaps.git

Change to the project's root directory and run:

$ pip install -e .

This will create a directory called static/ in the gmaps/ directory. This directory contains Javascript sources. Every time you change the Javascript sources, you will need to recompile this directory by re-running this command (despite everying being installed in editable mode).

You can then enable the extension in Jupyter:

$ jupyter nbextension install --py --symlink --sys-prefix gmaps
$ jupyter nbextension enable --py --sys-prefix gmaps

Testing

We use nose for unit testing. Run nosetests in the root directory of the project to run all the tests, or in a specific directory to just run the tests in that directory.

Guidelines

Workflow

We loosely follow the git workflow used in numpy development. Features should be developed in separate branches and merged into the master branch when complete.

Code

Please follow the PEP8 conventions for formatting and indenting code and for variable names.