Differential D2590 Diff 9229 docs/developer-setup.rst

Changeset View

Standalone View

docs/developer-setup.rst

	.. _developer-setup:			.. _developer-setup:

	Developer setup			Developer setup
	===============			===============

	In this guide we describe how to set up a developer environment in which one			In this guide we describe how to set up a developer environment in which one
	can easily navigate the source code, make modifications, write and execute unit			can easily navigate the source code, make modifications, write and execute unit
	tests.			tests.

	For this, we will use a `virtualenv`_ in which all the \|swh\| packages will be			For this, we will use a `virtualenv`_ in which all the \|swh\| packages will be
	installed in 'develop' mode, this will allow you to navigate the source code,			installed in 'develop' mode, this will allow you to navigate the source code,
	hack it, and run locally the unit tests.			hack it, and run locally the unit tests.

	If you want to test the effect of your modifications in a running \|swh\|			If you want to test the effect of your modifications in a running \|swh\|
	instance, you should check the `documentation`_ of the swh-docker-dev_ project.			instance, you should check the `documentation`_ of the docker-devs_ project.
				olasdUnsubmitted Not Done Inline Actions that label (`docker-devs`) doesn't exist. The "docker-dev project" doesn't really exist anymore so it might be better to rephrase this? olasd: that label (`docker-devs`) doesn't exist. The "docker-dev project" doesn't really exist anymore…
				olasdUnsubmitted Not Done Inline Actions no need for a possessive (`'s`) here. olasd: no need for a possessive (`'s`) here.

	.. _`documentation`: https://forge.softwareheritage.org/source/swh-docker-dev/browse/master/README.md?as=remarkup			.. _`documentation`: https://forge.softwareheritage.org/source/swh-environment/browse/master/docker/README.md?as=remarkup
	.. _`swh-docker-dev`: https://forge.softwareheritage.org/source/swh-docker-dev			.. _`docker-dev`: https://forge.softwareheritage.org/source/swh-environment
				ardumontAuthorUnsubmitted Done Inline Actions isn't it the label? ardumont: isn't it the label?
				olasdUnsubmitted Not Done Inline Actions The reference was plural and the label singular. olasd: The reference was plural and the label singular.
	.. _`virtualenv`: https://pypi.org/project/virtualenv/			.. _`virtualenv`: https://pypi.org/project/virtualenv/


	Install required dependencies			Install required dependencies
	-----------------------------			-----------------------------

	Software Heritage requires some dependencies that are usually packaged by your			Software Heritage requires some dependencies that are usually packaged by your
	package manager. On Debian/Ubuntu-based distributions::			package manager. On Debian/Ubuntu-based distributions::
	▲ Show 20 Lines • Show All 175 Lines • Show Last 20 Lines