About Us

Our combustion began at the grassroots level with free and open source software. Not only do we use it regularly, we also believe in the openness of development and collaboration as a means to producing viable and sustainable products. That’s why we’re thrilled to be contributors toward the development of OpenStack and Chef.

All our work is happening publically on GitHub, and we invite everyone to join in. If you’re looking to be a contributor, here’s how you can help.

Contributor Guidelines

Read our contributing guidelines below. They include how to:

  • Handle feature requests and issues
  • Submit pull requests
  • Comply with our coding standards

Feature Requests

We are not actively accepting community requests. We are, however, accepting any reproducible issues found within the Chef-OpenStack core.

Issues

Have an issue to report? Here are some guidelines to read through first.

Check the list of closed issues

Scroll through our list of closed issues to see if yours has already been resolved or reported.

Provide as much information as possible

Be sure to include any relevant information, such as the OpenStack release (Grizzly, Havana), which version, what components you use, when it was deployed, and so on.

Use Gist to help explain the issue

Create a gist of the code causing the issue, as well as any error messages, and include its URL in the issue report.

Open a new issue

Create a new issue on GitHub.

Pull Requests

Below is our workflow for pull requests.

  1. Visit our GitHub repo.
  2. Pick something you’d like to hack on, including any items loitering in the issues lists.
  3. Fork the project and work in a topic branch.
  4. Make sure any changes you made work with Chef-OpenStack.
  5. Add any documents or instructions that describe the behavior you’re committing.
  6. Rebase your branch against the master to ensure everything is up to date.
  7. Commit your changes and send a pull request.

Coding Standards

  • We appreciate the use of professional code quality standards

  • Keep code simple and clean

  • Follow the widely accepted and reasonable Ruby coding standards

    • Line length capped at 80 characters
    • Hash indices use " instead of '
    • String delimiters use " instead of ' when evaluation and escaping are not necessary
    • Align parameters of long function/method calls
    • Newlines at end of files
    • 2-space indentation, no tabs
    • Full list of standards available on GitHub and TomDoc

  • Use the correct letter case for syntax, products, and branding (e.g. SoftLayer, OpenStack, Swift)

  • Make indentation consistent

  • Remove trailing whitespace

Documentation

Our documentation is available publicly on GitHub. Here’s a list of all content related to this project.

Contribute to Our Docs

We treat our docs like we treat our code. And like our code, we invite everyone to join in.

  • We publish our Getting Started guide on GitHub Pages and use GitHub to track and manage changes.
  • Our web resources for Chef-OpenStack are managed under the gh-pages branch.
  • The wiki on GitHub is a clone of our online content. We use it for sharing while we’re working remote.

Community

Keep track of development and community efforts.

Copyright and License

Copyright © 2013 SoftLayer, an IBM Company. Our code and documentation is licensed under the MIT license. By contributing your code, you agree to license your contribution under the terms of this license.