Skip to content

Latest commit

 

History

History
111 lines (72 loc) · 5.84 KB

CONTRIBUTING.md

File metadata and controls

111 lines (72 loc) · 5.84 KB
Raw

Contributing

We're excited to collaborate with the community and look forward to the many improvements you can make to OpenTimelineIO!

Project Roles and Responsibilities

If you are new to this project, and want to contribute, then please read this document to understand the steps needed before you can submit code or changes to the project.

Also see the GOVERNANCE document for details on the rules and responsibilities of Contributors, Committers, and Technical Steering Committee members.

Committers

The OpenTimelineIO Project Committers (alphabetically by last name) are:

Contributor License Agreement

Before contributing code to OpenTimelineIO, we ask that you sign a Contributor License Agreement (CLA). When you create a pull request, the Linux Foundation's EasyCLA system will guide you through the process of signing the CLA.

If you are unable to use the EasyCLA system, you can send a signed CLA to [email protected] (please make sure to include your github username) and wait for confirmation that we've received it.

Here are the two possible CLAs:

Coding Conventions

Please follow the coding convention and style in each file and in each library when adding new files.

Git Workflow

Here is the workflow we recommend for working on OpenTimelineIO if you intend on contributing changes back:

Post an issue on github to let folks know about the feature or bug that you found, and mention that you intend to work on it. That way, if someone else is working on a similar project, you can collaborate, or you can get early feedback which can sometimes save time.

Use the github website to fork your own private repository.

Clone your fork to your local machine, like this:

git clone https://github.com/you/OpenTimelineIO.git

Add the primary OpenTimelineIO repo as upstream to make it easier to update your remote and local repos with the latest changes:

cd OpenTimelineIO
git remote add upstream https://github.com/AcademySoftwareFoundation/OpenTimelineIO.git

Now you fetch the latest changes from the OpenTimelineIO repo like this:

git fetch upstream
git merge upstream/main

All the development should happen against the main branch. We recommend you create a new branch for each feature or fix that you'd like to make and give it a descriptive name so that you can remember it later. You can checkout a new branch and create it simultaneously like this:

git checkout -b mybugfix upstream/main

Now you can work in your branch locally.

Once you are happy with your change, you can verify that the change didn't cause tests failures by running tests like this:

make test
make lint

If all the tests pass and you'd like to send your change in for consideration, push it to your remote repo:

git push origin mybugfix

Now your remote branch will have your mybugfix branch, which you can now pull request (to OpenTimelineIO's main branch) using the github UI.

Please make sure that your pull requests are clean. In other words, address only the issue at hand. Split minor corrections, formatting clean ups, and the like into other PRs. Ensure that new work has coverage in a test. Ensure that any resultant behavioral changes in other parts of the library are called out. Use the rebase and squash git facilities as needed to ensure that the pull request does not contain non-informative remnants of old or superseded work.

OpenTimelineIO-Plugins Versioning Strategy

OpenTimelineIO provides two PyPI packages:

  • opentimelineio - the core library and builtin file format support
  • opentimelineio-plugins - additional "batteries included" adapters

In short, the rules are:

  • OpenTimelineIO-Plugins pins to the same OpenTimelineIO PyPI version using the == constraint - in other words the OpenTimelineIO-Plugins version is in lock-step with OpenTimelineIO.
  • Each adapter specifies a version constraint against the OpenTimelineIO version based on that adapter's requirements.
  • The OpenTimelineIO-Plugins project depends on a set of adapters in a floating way, which lets the adapter repos individually deal with their dependency on the core.
  • OpenTimelineIO-Plugins is versioned only when plugins are added, removed, or the pinned version of OpenTimelineIO is updated.

Keeping OpenTimelineIO-Plugins versioning lock-step with OpenTimelineIO ensures that version constraints on OpenTimelineIO-Plugins will yield the same result as version constraints on OpenTimelineIO. For example, installing OpenTimelineIO-plugins==0.17.0 will guarantee that OpenTimelineIO 0.17.0 is installed. Individual adapter version can then be pinned by end-users.

Adapter developers should specify a loose version constraint on OpenTimelineIO (e.g. >=0.17.0) so that the package manager can discover the adapter version that works best with the desired OpenTimelineIO version.