Overview

You can contribute to the SEED-platform project in many ways: by using the software, reporting issues, contributing documentation, or contributing code back to the project. The GitHub Contributing to Open Source guide provides a good overview.

This wiki provides a quick overview of the software. Full documentation is available at http://seed-platform.readthedocs.org.

If you find a bug, report it in the GitHub issue tracker for this repository.

Questions and discussion about the code are handled on the seed-platform-dev google group. Please discuss your ideas there before embarking on any significant coding effort.

You may also want to join the seed-platform-users google group, which is a forum for users of SEED-platform to ask questions and get support, as well as a place for general announcements about the project.

Software Contributor Approval Process
To be approved as a SEED-Platform Affiliate, software contributors must follow this process:

• Fork the SEED-Platform Source Code
• Create a feature branch in the local repository
• Follow coding standards and testing requirements: patches should pass existing tests and provide new tests if needed, along with adequate documentation.
• Agree to the software contribution terms: The SEED-platform project does not currently have a contributor license agreement. Developers who contribute code to this project will retain the copyright in their work and at the same time grant permission for LBNL to distribute the software under the modified BSD license contained in this repository. Note that LBNL cannot accept into the project any code licensed under GPL, Apache 2, or other similarly restrictive licenses. If you wish to contribute code under any license other than the LBNL modified BSD license, please contact the LBNL team ahead of time so we can determine the acceptability of that license.
• Commit your changes
• Create a new Pull Request against SEED-Platform’s develop branch
• Check on the continuous integration test results in your pull request to verify that it successfully passed all the CI tests.
• Complete a code review, if requested
• Code contribution must be a significant feature addition or bug fix, and be accepted into the Master (stable) branch of SEED-Platform, in order to be officially recognized as a SEED-Platform Affiliate.