Difference between revisions of "Getting The Code"
(→Hacking on your laptop and running unit tests) |
|||
| (52 intermediate revisions by 24 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | == Git source code repositories == | |
| − | = | ||
| − | + | OpenStack manages source code in git using a code review tool called Gerrit. The workflow for working with Gerrit is described at [http://docs.openstack.org/infra/manual/developers.html#development-workflow Development Workflow]. Git repositories are mirrored to [http://git.openstack.org/ git.openstack.org] and [https://github.com/openstack GitHub]. Installing git varies by platform, and if you're a developer is probably something you already have - but if it isn't, [[InstallingGit]] may help. | |
| − | + | To get a copy of an OpenStack project, you can clone a repo from [https://opendev.org/ opendev.org] and browse the source code at [https://opendev.org/explore/repos opendev.org/explore/repos]. For instance, to clone the Swift repo: | |
| − | + | <pre><nowiki> | |
| + | git clone https://opendev.org/openstack/swift | ||
| + | </nowiki></pre> | ||
| − | + | Alternatively, you can use the [https://github.com/openstack GitHub mirror] to clone repos and browse code. The opendev.org and GitHub mirrors are maintained the same way and contain the same code, so you can use either one, with the difference being that opendev.org is hosted by the OpenDev infrastructure team. | |
| − | + | == Source code tarballs == | |
| − | + | You can find all source code tarballs of OpenStack projects on https://releases.openstack.org . | |
| − | + | Alternatively, you can find all source code tarballs generated for OpenStack projects at [http://tarballs.openstack.org tarballs.openstack.org]. | |
| − | |||
| − | + | == Getting dependencies == | |
| − | + | Python runtime and test dependencies are described in requirements.txt in each project. Some dependencies are not Python dependencies, though. See [[DevStack]] for more information on setting up the required dependencies. | |
| − | |||
| − | |||
| − | |||
| − | + | == Hacking on your laptop and running unit tests == | |
| − | + | ||
| − | + | Questions about running unit tests locally are fairly common. While all of the projects are pretty similar in how this works, it's best to consult each projects documentation for things like setting up a dev environment and running unit tests. | |
| + | |||
| + | Each project should publish this info to [http://docs.openstack.org/ docs.openstack.org]. | ||
| + | |||
| + | For example: | ||
| + | |||
| + | https://docs.openstack.org/cinder/latest/contributor/index.html | ||
| + | |||
| + | [[Category:Contribute]] | ||
Latest revision as of 21:36, 23 April 2019
Contents
Git source code repositories
OpenStack manages source code in git using a code review tool called Gerrit. The workflow for working with Gerrit is described at Development Workflow. Git repositories are mirrored to git.openstack.org and GitHub. Installing git varies by platform, and if you're a developer is probably something you already have - but if it isn't, InstallingGit may help.
To get a copy of an OpenStack project, you can clone a repo from opendev.org and browse the source code at opendev.org/explore/repos. For instance, to clone the Swift repo:
git clone https://opendev.org/openstack/swift
Alternatively, you can use the GitHub mirror to clone repos and browse code. The opendev.org and GitHub mirrors are maintained the same way and contain the same code, so you can use either one, with the difference being that opendev.org is hosted by the OpenDev infrastructure team.
Source code tarballs
You can find all source code tarballs of OpenStack projects on https://releases.openstack.org .
Alternatively, you can find all source code tarballs generated for OpenStack projects at tarballs.openstack.org.
Getting dependencies
Python runtime and test dependencies are described in requirements.txt in each project. Some dependencies are not Python dependencies, though. See DevStack for more information on setting up the required dependencies.
Hacking on your laptop and running unit tests
Questions about running unit tests locally are fairly common. While all of the projects are pretty similar in how this works, it's best to consult each projects documentation for things like setting up a dev environment and running unit tests.
Each project should publish this info to docs.openstack.org.
For example:
https://docs.openstack.org/cinder/latest/contributor/index.html
