1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
# Contributing
We're excited to collaborate with the community and look forward to the many improvements you can make to OpenTimelineIO!
## 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 `opentimelineio-tsc@aswf.io` (please make sure to include your github username) and wait for confirmation that we've received it.
Here are the two possible CLAs:
* [OTIO_CLA_Corporate.pdf](https://github.com/AcademySoftwareFoundation/OpenTimelineIO/raw/main/OTIO_CLA_Corporate.pdf): please sign this one for corporate use
* [OTIO_CLA_Individual.pdf](https://github.com/AcademySoftwareFoundation/OpenTimelineIO/raw/main/OTIO_CLA_Individual.pdf): please sign this one if you're an individual contributor
## Coding Conventions
Please follow the coding convention and style in each file and in each library when adding new files.
## Platform Support Policy
As recommended by the [VFX Platform](https://vfxplatform.com) (see "Support Guidance"), we support the intended calendar year of the release as well as the three prior years.
## 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:
```bash
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:
```bash
cd OpenTimelineIO
git remote add upstream https://github.com/AcademySoftwareFoundation/OpenTimelineIO.git
```
Now you fetch the latest changes from the OpenTimelineIO repo like this:
```bash
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:
```bash
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:
```bash
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:
```bash
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. Use the rebase and squash git facilities as needed to ensure that the pull request is as clean as possible.
|
