Contributing to geni-tools

The GENI-NSF repositories are very much a community driven effort, and your contributions are critical. A big thank you to all our contributors!

Mailing Lists

Omni users may raise issues or get announcements on the general GENI Users mailing list.
GCF / geni-tools developers can subscribe to gcf-developers@googlegroups.com here: https://groups.google.com/forum/#!forum/gcf-developers.
GENI developers discuss general GENI development on geni-developers@googlegroups.com. Subscribe here: https://groups.google.com/forum/#!forum/geni-developers.

GENI-NSF projects follow the general GitHub open source project guidelines.
Create a GitHub Issue for any bug, feature, or enhancement you find or intend to address.
Submit enhancements or bug fixes using pull requests (see the sample workflow below).
GENI-NSF projects use the branching model found at http://nvie.com/posts/a-successful-git-branching-model/
All work happens in issue-specific branches off of the develop branch.
For example, a branch for Issue 1234 might be named tkt1234-my-feature.
Note that all GENI-NSF code is released under the GENI Public License and should include that license.

Check existing issues first to see if the issue has already been reported.
Review the general GitHub guidlines on isssues.
Give specific examples, sample outputs, etc
Do not include any passwords, private keys, your omni.bundle, or any information you don't want public.
When reporting issues, please include the output of omni --version at least. Even better, include the complete stitcher.log or the output of running omni --debug.
To attach your stitcher.log or test case RSpecs or other large output, upload the file to some web server and provide a pointer. For example, to use Gist:
Copy & paste your log/patch/file attachment to http://gist.github.com/, hit the Create Public button and link to it from your issue by copying & pasting its URL.

GCF / geni-tools source code is available on GitHub.

Report the issue or check issue comments for a suggested solution.
Create an issue-specific branch off of the develop branch in your fork of the repository.

Per the branching model
E.G. git checkout develop, git pull origin develop, and then git checkout -b tkt1234-my-feature

Follow the code guidelines below.
Reference the appropriate issue numbers in your commit messages.
Include the GENI Public License and a copyright notice in any new source files.
All changes should be listed in the CHANGES file, with an issue number.
Changes to Omni should also be listed in README-omni.txt.
Where the options or command behavior has changed, document that in README-omni.txt or README-stitching.txt.

Test your Omni/Stitcher fix against multiple aggregate types and varying situations.
Changes to gcf should be tested with gcf-test.py minimally, and preferably also with the included AM acceptance tests or equivalent.

In your pull request description, note what issue(s) your pull request addresses.

Include the GENI Public License as a comment at the top of all source files.
Document all files and key classes and methods.
geni-tools attempts to be python2.6 compatible, and is not python3 compatible.
Use relative imports (from __future__ import absolute_import).
Use 4 space indents.
Name classes, methods, arguments and variables to describe their use.
Follow the Python Style Guide.

Thank you for your contributions!