Repo improvements #2

markreidvfx · 2022-08-06T20:25:22Z

This pull request address the following the tasks in #1

Add Code of Conduct and Contributing docs (matching unreal plugins style)
Fix Badge path in Readme
Add issue and pull request templates
Fix CI pip install OTIO URL
Add CodeCov CI support
Add Dependabot
Small Readme improvements

CodeCov/Dependabot might need to be enabled on the repo settings if it's not already.

Signed-off-by: Mark Reid <mindmark@gmail.com>

codecov-commenter · 2022-08-06T20:29:18Z

Codecov Report

❗ No coverage uploaded for pull request base (main@46f749e). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main       #2   +/-   ##
=======================================
  Coverage        ?   90.03%           
=======================================
  Files           ?        3           
  Lines           ?     1114           
  Branches        ?        0           
=======================================
  Hits            ?     1003           
  Misses          ?      111           
  Partials        ?        0

Flag	Coverage Δ
unittests	`90.03% <0.00%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Bump readthedocs-sphinx-ext from 2.1.5 to 2.1.8 Bump myst-parser from 0.17.2 to 0.18.0 Signed-off-by: Mark Reid <mindmark@gmail.com>

Signed-off-by: Mark Reid <mindmark@gmail.com>

JeanChristopheMorinPerso

I made some small comments. but it looks pretty good to me.

JeanChristopheMorinPerso · 2022-08-24T23:14:18Z

.github/PULL_REQUEST_TEMPLATE.md

+
+Each PR should link at least one issue, in the form:
+
+```Fixes #123```


Suggested change

```Fixes #123```

Fixes #123

I guess that was copied from OTIO repo. Using triple backquotes here will lead to Fixes #123 which GitHub won't be able to understand and so won't link the PR to the issue. Eventually it also needs to be fixed in OTIO.

yes, this was just copied from the main OTIO repo.

JeanChristopheMorinPerso · 2022-08-24T23:17:05Z

README.md

+------------
+
+* [OpenTimelineIO](https://github.com/AcademySoftwareFoundation/OpenTimelineIO) > 14.1 (latest git version currently recommended)
+* [pyaaf2](https://github.com/markreidvfx/pyaaf2) >= 1.4.0


Is it necessary to list the requirements? They are already set in the setup.py. I find that redundant.

I personally don't like having to dig into a project files to find such basic information, but I can remove it if preferred.

I like the idea of making it clear that you need these two packages (esp pyaaf2), but let's omit the version info here, since that may change often.

good idea, I'll remove the version numbers.

JeanChristopheMorinPerso · 2022-08-24T23:19:00Z

README.md

+Overview
+--------


Suggested change

Overview

--------

# Overview

I would recommend using markdown headers. It will render more nicely.

JeanChristopheMorinPerso · 2022-08-24T23:19:50Z

README.md

+-------------
+
+If you have any suggested changes to the otio-aaf-adapter,
+please provide them via [pull request](../../pulls) or [create an issue](../../issues) as appropriate.


This really works? If so I just learned something!

yes it does, saw some other repos doing it. Was very surprised too that it works!

JeanChristopheMorinPerso · 2022-08-24T23:21:44Z

setup.cfg

@@ -23,7 +23,7 @@ ignore =
    W504

 [tool:pytest]
-addopts = --cov=./ -W ignore::DeprecationWarning
+addopts = --cov=otio_aaf_adapter -W ignore::DeprecationWarning


Suggested change

addopts = --cov=otio_aaf_adapter -W ignore::DeprecationWarning

addopts = --cov=otio_aaf_adapter

It is generally better if CI logs (or even fails, -W error::DeprecationWarning) when DeprecationWarnings are encountered.

It is like that in the template repo, but I agree

We could try turning that off to see if it passes. I suspect that since we're running against such a wide range of Python versions that some deprecations are unavoidable...

I've already turned it off ignore and all the tests still pass. I didn't try -W error::DeprecationWarning though, I thought that would be overkill for now.

JeanChristopheMorinPerso · 2022-08-24T23:22:48Z

.github/PULL_REQUEST_TEMPLATE.md

+<!--
+Important: If this is your first contribution to OpenTimelineIO, you will need to submit a Contributor License Agreement. For a step-by-step instructions on the pull request process, see
+https://github.com/AcademySoftwareFoundation/OpenTimelineIO/tree/main/CONTRIBUTING.md
+-->


Should this stay here? Will CLA/CCLA be required for the adapters repos?

It is my assumption that it is needed for officially supported adapters.

We discussed the pros/cons among the TSC and decided that yes, we would like to have the same CLA (and DCO) requirements for repos in the OpenTimelineIO GitHub organization. That will ensure that all the approvals and such are uniform between these and the core repo in the ASWF org. If a particular repo needs/wants to follow different rules, it can just live in a different org.
Does that sound reasonable to you two @markreidvfx and @JeanChristopheMorinPerso ?

Sounds reasonable to me!
I don't think DCO has been activated for this repo yet, I believe its somewhere in the repo settings.
Having EasyCLA available for plugin repos at some point would be great too.

I have no problem with DCO and CLAs in general, but I do find that they are kind of a barrier of entry in some cases. I find that it's a lot of bureaucracy to contribute to an adapter. But I guess there is some legal questions regarding adapters that are moved out of the OTIO repo and stuff like that? Anyway, if the TSC decided to go with CLAs+DCO, then that's the way it is. I'll still happily sign the CLAs and contribute :)

JeanChristopheMorinPerso · 2022-08-24T23:26:45Z

.github/ISSUE_TEMPLATE/bug_report.md

+5. Compiler information:
+    on Mac, type `clang -v`, and paste the results here
+    on Linux, type `gcc -v`, and paste the results here
+    on Windows, type `cl`, and paste the results here.
+    If you are unable to determine your compiler via these commands, please indicate that here.


I don't think it's relevant here since pyaaf2 is pure Python? Or potentially we keep it here just in case someone simply installs otio-aaf-adapter without actually installing OTIO (which would mean OTIO would be installed by otio-aaf-adapter)?

I can get rid of this, I just missed it when copying the file over from the main OTIO repo

Signed-off-by: Mark Reid <mindmark@gmail.com>

jminor · 2022-09-02T22:37:07Z

CONTRIBUTORS.md

+* Mark Reid ([markreidvfx](https://github.com/markreidvfx))
+* Stefan Schulze ([stefanschulze](https://github.com/stefanschulze))
+* Stephan Steinbach ([ssteinbach](https://github.com/ssteinbach))
+* Tim Lehr ([timlehr](https://github.com/timlehr))


Could you add these people also?

* Shahbaz Khan ([shahbazk8194](https://github.com/shahbazk8194)) * Freeson Wang ([freesonluxo](https://github.com/freesonluxo)) * Andrew Moore ([andrewmoore-nz](https://github.com/andrewmoore-nz))

jminor

This is looking fantastic! There's just a couple of tiny changes left as comments.

Signed-off-by: Mark Reid <mindmark@gmail.com>

markreidvfx · 2022-09-03T02:39:38Z

Added the requested changes to the pull. Everything should be addressed unless I missed something :p

ssteinbach

LGTM

markreidvfx added 5 commits August 4, 2022 16:17

Add code of conduct and contributors docs

8909275

Signed-off-by: Mark Reid <mindmark@gmail.com>

Fix badge url

47d734e

Signed-off-by: Mark Reid <mindmark@gmail.com>

Add issue and pull request templates

d3e4942

Signed-off-by: Mark Reid <mindmark@gmail.com>

Pip install from pull request

bdb07c1

Signed-off-by: Mark Reid <mindmark@gmail.com>

Add Codecov support

6afdc23

Signed-off-by: Mark Reid <mindmark@gmail.com>

markreidvfx added 3 commits August 7, 2022 19:44

Bump sphinx from 4.5.0 to 5.1.1

d441156

Bump readthedocs-sphinx-ext from 2.1.5 to 2.1.8 Bump myst-parser from 0.17.2 to 0.18.0 Signed-off-by: Mark Reid <mindmark@gmail.com>

Add dependabot

6e6b6e5

Signed-off-by: Mark Reid <mindmark@gmail.com>

Improvements to README

4f4b000

Signed-off-by: Mark Reid <mindmark@gmail.com>

markreidvfx assigned markreidvfx and unassigned markreidvfx Aug 11, 2022

JeanChristopheMorinPerso reviewed Aug 24, 2022

View reviewed changes

markreidvfx added 3 commits August 28, 2022 21:26

Don't ignore deprecation warnings

482374a

Signed-off-by: Mark Reid <mindmark@gmail.com>

Remove compiler info bit and fix some typos

80f0471

Signed-off-by: Mark Reid <mindmark@gmail.com>

Use markdown instead of RST style headers

c51115d

Signed-off-by: Mark Reid <mindmark@gmail.com>

jminor reviewed Sep 2, 2022

View reviewed changes

jminor requested changes Sep 2, 2022

View reviewed changes

markreidvfx added 2 commits September 2, 2022 18:44

Add a few missing contributors

bb39d85

Signed-off-by: Mark Reid <mindmark@gmail.com>

Remove version numbers since they might change often

c81e3d0

Signed-off-by: Mark Reid <mindmark@gmail.com>

markreidvfx force-pushed the repo_improvements_v1 branch from e5208cc to c81e3d0 Compare September 3, 2022 01:51

markreidvfx requested a review from jminor September 13, 2022 20:20

ssteinbach approved these changes Sep 27, 2022

View reviewed changes

ssteinbach merged commit 8bde894 into OpenTimelineIO:main Oct 3, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repo improvements #2

Repo improvements #2

markreidvfx commented Aug 6, 2022 •

edited

Loading

codecov-commenter commented Aug 6, 2022 •

edited

Loading

JeanChristopheMorinPerso left a comment

JeanChristopheMorinPerso Aug 24, 2022

markreidvfx Aug 28, 2022

JeanChristopheMorinPerso Aug 24, 2022

markreidvfx Aug 28, 2022

jminor Sep 2, 2022

markreidvfx Sep 3, 2022 •

edited

Loading

JeanChristopheMorinPerso Aug 24, 2022

JeanChristopheMorinPerso Aug 24, 2022

markreidvfx Aug 28, 2022 •

edited

Loading

JeanChristopheMorinPerso Aug 24, 2022

markreidvfx Aug 28, 2022

jminor Sep 2, 2022

markreidvfx Sep 3, 2022

JeanChristopheMorinPerso Aug 24, 2022

markreidvfx Aug 28, 2022

jminor Sep 2, 2022

markreidvfx Sep 3, 2022 •

edited

Loading

JeanChristopheMorinPerso Sep 3, 2022 •

edited

Loading

JeanChristopheMorinPerso Aug 24, 2022

markreidvfx Aug 28, 2022

jminor Sep 2, 2022 •

edited

Loading

markreidvfx Sep 3, 2022

jminor left a comment

markreidvfx commented Sep 3, 2022

ssteinbach left a comment


		Each PR should link at least one issue, in the form:

		```Fixes #123```

	addopts = --cov=otio_aaf_adapter -W ignore::DeprecationWarning
	addopts = --cov=otio_aaf_adapter

Repo improvements #2

Repo improvements #2

Conversation

markreidvfx commented Aug 6, 2022 • edited Loading

codecov-commenter commented Aug 6, 2022 • edited Loading

Codecov Report

JeanChristopheMorinPerso left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

markreidvfx Sep 3, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

markreidvfx Aug 28, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

markreidvfx Sep 3, 2022 • edited Loading

Choose a reason for hiding this comment

JeanChristopheMorinPerso Sep 3, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jminor Sep 2, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jminor left a comment

Choose a reason for hiding this comment

markreidvfx commented Sep 3, 2022

ssteinbach left a comment

Choose a reason for hiding this comment

markreidvfx commented Aug 6, 2022 •

edited

Loading

codecov-commenter commented Aug 6, 2022 •

edited

Loading

markreidvfx Sep 3, 2022 •

edited

Loading

markreidvfx Aug 28, 2022 •

edited

Loading

markreidvfx Sep 3, 2022 •

edited

Loading

JeanChristopheMorinPerso Sep 3, 2022 •

edited

Loading

jminor Sep 2, 2022 •

edited

Loading