Yichen Wang d7d9575dda Cleanup logic enhancements, document enhancements

1. Enhance the cleanup logic;
2. Add the missing keypair into the resource logger;
3. Document enhancements on installation and contribution;
4. Fix the bug when parsing the image version string in DIB;
5. Fix the typo in Rest API specification;

Change-Id: Ibf4a1c7828ee4522938b4b55f9a8af5e6c6a133b

2015-09-02 22:59:28 -07:00

2.8 KiB

Raw Blame History

Contributing

Contribute to KloudBuster

Below are a simplified version of the workflow to work on KloudBuster. For complete instructions, you have to follow the Developer's Guide in OpenStack official documents. Refer to below section <developer_guide_of_openstack> for links.

Start working

Before starting, a GitHub/OpenStack respository based installation must be done. Refer here <git_installation> for detailed documentation.

From the root of your workspace, check out a new branch to work on:
```
$ git checkout -b <TOPIC-BRANCH>
```
Happy working on your code for features or bugfixes;

Before Commit

There are some criteria that are enforced to commit to KloudBuster. Below commands will perform the check and make sure your code complys with it.

PEP 8:
```
$ tox -epep8
```

Note

The first run usually takes longer, as tox will create a new virtual environment and download all dependencies. Once that is the done, further run will be very fast.

Run the test suite:
```
$ tox -epython27
```
If you made a documentation change (i.e. changes to .rst files), make sure the documentation is built as you expected:
```
$ cd <kloudbuster-ws-root>/doc
$ make html
```

Once finished, the documentation in HTML format will be ready at <kloudbuster-ws-root>/doc/build/html.

Submit Review

Commit the code:
```
$ git commit -a
```

Note

For a feature commit, please supply a clear commit message indicating what the feature is; for a bugfix commit, please also containing a launchpad link to the bug you are working on.

Submit the review:
```
$ git review <TOPIC-BRANCH>
```

The members in the KloudBuster team will get notified once the Jenkin verification is passed. So watch your email from the review site, as it will contain the updates for your submission.

If the code is approved with a +2 review, Gerrit will automatically merge your code.

File Bugs

Bugs should be filed on Launchpad, not GitHub:

https://bugs.launchpad.net/kloudbuster

Developer's Guide of OpenStack

Feedbacks and contributions to KloudBuster are welcome.

KloudBuster follows the same workflow as any other OpenStack project.

If you would like to contribute to the development of OpenStack, you must follow the steps in this page:

http://docs.openstack.org/infra/manual/developers.html

If you already have a good understanding of how the system works and your OpenStack accounts are set up, you can skip to the development workflow section of this documentation to learn how changes to OpenStack should be submitted for review via the Gerrit tool:

http://docs.openstack.org/infra/manual/developers.html#development-workflow

Pull requests submitted through GitHub will be ignored.

2.8 KiB Raw Blame History