{"id": "contributing:devenvironment", "page": "contributing", "ref": "devenvironment", "title": "Setting up a development environment", "content": "If you have Python 3.8 or higher installed on your computer (on OS X the quickest way to do this  is using homebrew ) you can install an editable copy of Datasette using the following steps. \n             If you want to use GitHub to publish your changes, first  create a fork of datasette  under your own GitHub account. \n             Now clone that repository somewhere on your computer: \n             git clone git@github.com:YOURNAME/datasette \n             If you want to get started without creating your own fork, you can do this instead: \n             git clone git@github.com:simonw/datasette \n             The next step is to create a virtual environment for your project and use it to install Datasette's dependencies: \n             cd datasette\n# Create a virtual environment in ./venv\npython3 -m venv ./venv\n# Now activate the virtual environment, so pip can install into it\nsource venv/bin/activate\n# Install Datasette and its testing dependencies\npython3 -m pip install -e '.[test]' \n             That last line does most of the work:  pip install -e  means \"install this package in a way that allows me to edit the source code in place\". The  .[test]  option means \"use the setup.py in this directory and install the optional testing dependencies as well\".", "breadcrumbs": "[\"Contributing\"]", "references": "[{\"href\": \"https://docs.python-guide.org/starting/install3/osx/\", \"label\": \"is using homebrew\"}, {\"href\": \"https://github.com/simonw/datasette/fork\", \"label\": \"create a fork of datasette\"}]"}
{"id": "contributing:general-guidelines", "page": "contributing", "ref": "general-guidelines", "title": "General guidelines", "content": "main should always be releasable . Incomplete features should live in branches. This ensures that any small bug fixes can be quickly released. \n                 \n                 \n                     The ideal commit  should bundle together the implementation, unit tests and associated documentation updates. The commit message should link to an associated issue. \n                 \n                 \n                     New plugin hooks  should only be shipped if accompanied by a separate release of a non-demo plugin that uses them.", "breadcrumbs": "[\"Contributing\"]", "references": "[]"}
{"id": "contributing:id1", "page": "contributing", "ref": "id1", "title": "Contributing", "content": "Datasette is an open source project. We welcome contributions! \n         This document describes how to contribute to Datasette core. You can also contribute to the wider Datasette ecosystem by creating new  Plugins .", "breadcrumbs": "[]", "references": "[]"}