openstack/designate
Code Issues Proposed changes
5203c5cb6c
designate/README.rst
Graham Hayes b25ab0e1dc Update README to RST 
This allows the tooling used by the release management team parse the
content to grab links to bug trackers and docs.

Also updated the sample test command to a working one

Change-Id: I1dcfb2b5ae3ba07fbaf6eaabfef1d9e7da778400
Closes-Bug: #1532735
2016-02-23 15:16:18 +00:00

1.9 KiB
Raw Blame History

OpenStack Designate

Designate is an OpenStack project, providing DNSaaS.

IRC: #openstack-dns

Installation: http://docs.openstack.org/developer/designate/getting-started.html

Development

Designate follows the OpenStack Gerrit Workflow

Setup

Setup a working environment:

git clone https://github.com/openstack/designate.git
cd designate
virtualenv .venv
. .venv/bin/activate
pip install -r requirements.txt -r test-requirements.txt
python setup.py develop

Building Docs

To build the documentation from the restructured text source, do the following:

cd doc
pip install -r requirements.txt
sphinx-build  source/ build/html/

now point your browser at html/index.html (the official documentation is published to docs.openstack.org by the maintainers.

Contributing

Install the git-review package to make life easier

pip install git-review

Branch, work, & submit:

# cut a new branch, tracking master
git checkout --track -b bug/id origin/master
# work work work
git add stuff
git commit
# rebase/squash to a single commit before submitting
git rebase -i
# submit
git-review

Testing

Execute a single test using py27 (test is CentralServiceTest.test_count_domains)

tox -e py27 -- designate.tests.test_central.test_service.CentralServiceTest.test_count_zones_policy_check