Before contributing code to this project, we ask that you sign a Contributor License Agreement (CLA):
- Corporate Contributor License Agreement (Word), please sign this one for corporate use.
- Individual Contributor License Agreement (Word), please sign this one if you're an individual contributor.
The documents include instructions on where to send the completed forms. Once a signed form has been received you will be able to submit pull requests.
The Bifrost USD project is meant to evolve with feedback - the project and its users greatly appreciate any thoughts on ways to improve the design or features. Please use the enhancement tag to specifically denote issues that are suggestions - this helps us triage and respond appropriately.
As with all pieces of software, you may end up running into bugs. Please submit bugs as regular issues on GitHub. Bifrost USD developers are regularly monitoring issues and will prioritize and schedule fixes.
The best bug reports include the following:
- Detailed steps to reliably reproduce the issue.
- A description of what the expected and the actual results are.
- Any screenshots or associated sample files to aid in reproducing the issue.
- What software versions and hardware is being used.
- Any other supplemental information that maybe useful in reproducing and diagnosing the issue.
The Bifrost USD project accepts and greatly appreciates contributions. The project follows the fork & pull model for accepting contributions.
When contributing code, please also include appropriate tests as part of the pull request, and follow the same comment and coding style as the rest of the project. Take a look through the existing code for examples of the testing and style practices the project follows.
All development should happen against the "dev" branch of the repository. Please make sure the base branch of your pull request is set to the "dev" branch when filing your pull request.
It is highly recommended that an issue be logged on GitHub before any work is started. This will allow for early feedback from other developers and avoid multiple parallel efforts.