Skip to content

Commit

Permalink
Autodesk's Open RV original contribution
Browse files Browse the repository at this point in the history
  • Loading branch information
bernie-laberge committed Jan 18, 2023
1 parent 3ab997d commit 41eccbe
Show file tree
Hide file tree
Showing 2,974 changed files with 719,562 additions and 1 deletion.
94 changes: 94 additions & 0 deletions .clang-format
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
---
Language: Cpp
AccessModifierOffset: -1
AlignAfterOpenBracket: Align
AlignConsecutiveAssignments: false
AlignConsecutiveDeclarations: false
AlignEscapedNewlinesLeft: true
AlignOperands: true
AlignTrailingComments: true
AllowAllParametersOfDeclarationOnNextLine: true
AllowShortBlocksOnASingleLine: false
AllowShortCaseLabelsOnASingleLine: false
AllowShortFunctionsOnASingleLine: Empty
AllowShortIfStatementsOnASingleLine: true
AllowShortLoopsOnASingleLine: true
AlwaysBreakAfterDefinitionReturnType: None
AlwaysBreakAfterReturnType: None
AlwaysBreakBeforeMultilineStrings: true
AlwaysBreakTemplateDeclarations: true
BinPackArguments: true
BinPackParameters: true
BraceWrapping:
AfterClass: true
AfterControlStatement: true
AfterEnum: true
AfterFunction: true
AfterNamespace: true
AfterObjCDeclaration: true
AfterStruct: true
AfterUnion: false
BeforeCatch: true
BeforeElse: true
IndentBraces: false
BreakBeforeBinaryOperators: None
BreakBeforeBraces: Allman
BreakBeforeTernaryOperators: true
BreakConstructorInitializersBeforeComma: false
BreakAfterJavaFieldAnnotations: false
BreakStringLiterals: true
ColumnLimit: 80
CommentPragmas: '^ IWYU pragma:'
ConstructorInitializerAllOnOneLineOrOnePerLine: true
ConstructorInitializerIndentWidth: 4
ContinuationIndentWidth: 4
Cpp11BracedListStyle: true
DisableFormat: false
ExperimentalAutoDetectBinPacking: false
ForEachMacros: [ foreach, Q_FOREACH, BOOST_FOREACH ]
IncludeCategories:
- Regex: '^<.*\.h>'
Priority: 1
- Regex: '^<.*'
Priority: 2
- Regex: '.*'
Priority: 3
IncludeIsMainRegex: '([-_](test|unittest))?$'
IndentCaseLabels: true
IndentWidth: 2
IndentWrappedFunctionNames: false
JavaScriptQuotes: Leave
JavaScriptWrapImports: true
KeepEmptyLinesAtTheStartOfBlocks: false
MacroBlockBegin: ''
MacroBlockEnd: ''
MaxEmptyLinesToKeep: 1
NamespaceIndentation: All
ObjCBlockIndentWidth: 2
ObjCSpaceAfterProperty: false
ObjCSpaceBeforeProtocolList: false
PenaltyBreakBeforeFirstCallParameter: 1
PenaltyBreakComment: 300
PenaltyBreakFirstLessLess: 120
PenaltyBreakString: 1000
PenaltyExcessCharacter: 1000000
PenaltyReturnTypeOnItsOwnLine: 200
PointerAlignment: Left
ReflowComments: true
SortIncludes: false
SpaceAfterCStyleCast: false
SpaceBeforeAssignmentOperators: true
SpaceBeforeParens: Never
SpaceInEmptyParentheses: false
SpacesBeforeTrailingComments: 2
SpacesInAngles: false
SpacesInContainerLiterals: true
SpacesInCStyleCastParentheses: false
SpacesInParentheses: true
SpacesInSquareBrackets: false
Standard: Auto
TabWidth: 2
UseTab: Never
---
Language: JavaScript
DisableFormat: true
11 changes: 11 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
*.jpg -crlf -diff -merge
*.png -crlf -diff -merge
*.exr -crlf -diff -merge
*.dpx -crlf -diff -merge
*.cin -crlf -diff -merge
*.tiff -crlf -diff -merge
*.tif -crlf -diff -merge
*.eps -crlf -diff -merge
*.nib -crlf -diff -merge
*.nib -crlf -diff -merge
*.pdf -crlf -diff -merge
28 changes: 28 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
**/.DS_Store

.vscode/**
.idea/**

# Qt generated
**/*.moc
**/moc_*.cpp
**/ui_*.h
**/qrc_*.cpp
**/*.qmlc
**/*.pkg
**/*.dmg

# Windows
**/*.pdb
**/*.idb

**/*.xcodeproj/

compile_commands.json

**/__pycache__
**/*.pyc

cmake-*/*
build/*
_build/*
9 changes: 9 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[submodule "src/lib/files/WFObj"]
path = src/lib/files/WFObj
url = https://github.com/shotgunsoftware/openrv-WFObj.git
[submodule "src/pub"]
path = src/pub
url = https://github.com/shotgunsoftware/openrv-pub.git
[submodule "src/lib/oiio"]
path = src/lib/oiio
url = https://github.com/shotgunsoftware/openrv-oiio.git
11 changes: 11 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
repos:
- repo: https://github.com/cheshirekow/cmake-format-precommit
rev: v0.6.13
hooks:
- id: cmake-format

- repo: https://github.com/psf/black
rev: 22.8.0
hooks:
- id: black
language_version: python3.10
76 changes: 76 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
#
# Copyright (C) 2022 Autodesk, Inc. All Rights Reserved.
#
# SPDX-License-Identifier: Apache-2.0
#
CMAKE_MINIMUM_REQUIRED(VERSION 3.24)

SET(CMAKE_CONFIGURATION_TYPES
"Debug;Release"
CACHE STRING "" FORCE
)

IF(NOT CMAKE_BUILD_TYPE)
SET(CMAKE_BUILD_TYPE
"Debug"
)
ENDIF()

IF(CMAKE_BUILD_TYPE
AND NOT CMAKE_BUILD_TYPE MATCHES "^(Debug|Release)$"
)
MESSAGE(FATAL_ERROR "Invalid value for CMAKE_BUILD_TYPE: ${CMAKE_BUILD_TYPE}")
ENDIF()

SET(CMAKE_BUILD_TYPE
"${CMAKE_BUILD_TYPE}"
CACHE STRING "CMake Build Type"
)

MESSAGE(STATUS "Build type: ${CMAKE_BUILD_TYPE}")

# Specify our own CMake modules so we can include them right after.
SET(CMAKE_MODULE_PATH
${CMAKE_MODULE_PATH} ${CMAKE_SOURCE_DIR}/cmake/defaults ${CMAKE_SOURCE_DIR}/cmake/dependencies ${CMAKE_SOURCE_DIR}/cmake/globals
${CMAKE_SOURCE_DIR}/cmake/macros
)

SET(CMAKE_OSX_DEPLOYMENT_TARGET
"10.14"
)
INCLUDE(rv_version) # RV's build system global variables

PROJECT(
open-rv
VERSION ${RV_VERSION_STRING}
LANGUAGES CXX C
)

INCLUDE(rv_options) # RV's build options
INCLUDE(rv_targets) # RV's build platform definitions
INCLUDE(rv_globals) # RV's CMake-build global variables
INCLUDE(rv_stage) # RV's local appplication packaging
INCLUDE(CTest)

# The 'cxx_defaults' module will sets global C/C++ compiler defaults Note that variable such as 'CMAKE_CXX_COMPILER_ID' is only available after the 'project'
# statement just above.
INCLUDE(cxx_defaults)

# This should handle fetching or checking then compiling required 3rd party dependencies One can simple disable processing of a given dependency by simply
# commenting out the relevant line. (macOS) /usr/local/Cellar/cmake/3.20.3/share/cmake/Modules/FetchContent.cmake
INCLUDE(FetchContent) # once in the project to include the module
INCLUDE(ExternalProject) # once in the project to include the module

# Force verbosity of the FETCHCONTENT function, thus outputting some progress rather than just stalling CMake. Fetching and expanding an archive takes some
# time, as an indicator that something is actually happening, we'll force verbosity of the FETCHCONTENT function thus printing some minimal progress.
SET(FETCHCONTENT_QUIET
OFF
)

ADD_SUBDIRECTORY(cmake/dependencies)

# RV's main code
ADD_SUBDIRECTORY(src)
ADD_SUBDIRECTORY(packages)

ADD_SUBDIRECTORY(cmake/install)
8 changes: 8 additions & 0 deletions COMMITERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Committers

This is a list of commiters for the Open RV project, sorted alphabetically by first name.

* Alain Compagnat ([compaga](https://github.com/compaga))
* Bernard Laberge ([bernie-laberge](https://github.com/bernie-laberge))
* Kerby Geffrard ([geffrak](https://github.com/geffrak))
* Roger Nelson ([rogernelson](https://github.com/rogernelson))
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Contributing

Thank you for your interest in contributing to Open RV. We are looking forward to collaborating with the community to evolve and improve Open RV.

## Project Roles and Responsibilities

Please read this document to learn how to contribute to Open RV.

Start by getting familiar with the [GOVERNANCE](GOVERNANCE.md) document. It details the rules and responsibilities for Contributors, Committers, and Technical Steering Committee members.

## Committers

The RV Open Source Project Committers are listed in alphabetical order, by first name, in [COMMITERS](COMMITERS.md)

## Contributor License Agreement

Before contributing code to Open RV source code, you must sign a Contributor License Agreement (CLA).

You will get the opportunity to sign the CLA when you create your first pull request: the Linux Foundation's EasyCLA system will guide you through the process of signing the CLA.

If you can't to use the EasyCLA system, you can always send a signed CLA to `[email protected]` (making sure to include your *github username*), and wait for confirmation that we've received it.

Here are the two possible CLAs:

There are two contribution agreement types, one for individuals contributing independently, and one for corporations who want to manage a list of contributors for their organization. Please review the documents in the EasyCLA portal to determine which is the right one for you.

## Coding Conventions

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

## Git Workflow

Follow instructions from the [README](README.md).
13 changes: 13 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Contributors

This is a list of the people who have contributed code to the Open RV project, sorted alphabetically by first name.

* Alain Compagnat ([compaga](https://github.com/compaga))
* Bernard Laberge ([bernie-laberge](https://github.com/bernie-laberge))
* Eric Desruisseaux ([eric-desruisseaux-adsk](https://github.com/eric-desruisseaux-adsk))
* Guillaume Brossard ([guillaume-brossard](https://github.com/guillaume-brossard))
* Ian Savoie ([savoiei](https://github.com/savoiei))
* Kerby Geffrard ([geffrak](https://github.com/geffrak))
* Martin Chesnay ([mchesnay](https://github.com/mchesnay))
* Nicolas Montmarquette ([nmontmarquette](https://github.com/nmontmarquette))
* Roger Nelson ([rogernelson](https://github.com/rogernelson))
103 changes: 103 additions & 0 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# Open RV Project Roles and Responsibilities

Open RV is a project of the Academy Software Foundation and relies on the ASWF governance policies, supported by the Linux Foundation.

Open RV is overseen by the Open Review Initiative but it has its own governance.

There are three primary project roles:

* [Contributors](#contributors) submit code to the project;
* [Committers](#committers) approve code to be included into the project; and
* [Technical Steering Committee](#technical-steering-committee) (TSC) provides overall high-level project guidance.

## Contributors

Open RV grows and thrives from assistance from Contributors. Contributors include anyone in the community who contributes code, documentation, or other technical artifacts that have been incorporated into the project's repository.
Anyone can be a Contributor. You need no formal approval from the project, beyond the legal forms.

### How to Become a Contributor

* Review the coding standards to ensure your contribution is in line with the project's coding and styling guidelines.
* Sign the Individual CLA, or if you are employed by an organization that might have any claim to IP you create, have your organization sign the Corporate CLA.
* Submit your code as a PR with the appropriate DCO sign-off.

## Committers

Project Committers have merge access on the Open RV GitHub repository, or repositories underneath its control, and are responsible for approving submissions by Contributors.

### Committer Responsibilities

Typical activities of a Committer include:

* Helping users and novice contributors.
* Ensuring a response to questions posted to the Open RV-dev developer mail list
* Contributing code and documentation changes that improve the project.
* Reviewing and commenting on issues and pull requests.
* Ensuring that changes and new code meet acceptable standards and are in the long-term interest of the project.
* Participation in working groups.
* Merging pull requests.

### How to Become a Committer

Any member of the Open RV community (though typically an existing Committer or TSC member) may nominate an individual making significant and valuable contributions to the Open RV project to become a new Committer. To nominate a new Committer, open an issue in the Open RV repository, send mail to the TSC mail list, or raise the issue at a TSC meeting.
The TSC may periodically review the Committer list to identify inactive Committers. Past Committers are typically given Emeritus status. Emeriti may request that the TSC restore them to active Committer status.

## Technical Steering Committee

The Technical Steering Committee (TSC) has final authority over this project. As defined in the project charter, TSC responsibilities include, but are not limited to:

* Coordinating technical direction of the Project.
* Project governance and contribution policy.
* GitHub repository administration.
* Maintaining the list of additional Committers
* Appointing representatives to work with other open source or open standards communities.
* Discussions, seeking consensus, and where necessary, voting on technical matters relating to the code base that affect multiple projects.
* Coordinating any marketing, events, or communications regarding the project.

Within the TSC are two elected leadership roles to be held by its members and voted on annually. Any TSC member can express interest in serving in a role, or nominate another member to serve. There are no term limits, and one person may hold multiple roles simultaneously. Should a TSC member resign from a leadership role before their term is complete, a successor shall be elected through the standard nomination and voting process to complete the remainder of the term.

The leadership roles are:

* Chair: This position acts as the project manager, organizing meetings and providing oversight to project administration.
* Chief Architect: This position makes all the final calls on design and technical decisions, and is responsible for avoiding "design by committee" pitfalls.

The chair role is assumed to rotate annually (though there are no term limits, so the TSC may reelect an existing chair). The chief architect position should be a source of stability and coherent design vision, so the TSC is encouraged to choose an architect who can serve for many years and only change architects when it is necessary for the health of the project and its community.

At the time of election, the TSC will also agree upon which of these two leaders will serve as the Open RV representative for the term. This member represents the project at all ASWF ORI meetings.

### Current TSC Members

Current voting members of the TSC are:

* Chair and Open RV representative: Alain Compagnat ([compaga](https://github.com/compaga))
* Chief architect: Bernard Laberge ([bernie-laberge](https://github.com/bernie-laberge))
* Roger Nelson ([rogernelson](https://github.com/rogernelson))
* [Name] To be filled
* [Name] To be filled

### TSC Nomination and Succession

Any proposal for additional members of the TSC may be submitted by Committers, TSC members, or other major stakeholders of the Open RV community by opening an issue outlining their case or raising the issue at a TSC meeting. New TSC members are accepted or rejected by majority vote of the TSC.

If a TSC member is for an extended period not regularly participating or performing the responsibilities expected of TSC members, the TSC may by majority vote request an alternate TSC member be submitted by that organization, or remove the inactive member from the TSC.
A voting member of the TSC may nominate a successor in the event that such voting member decides to leave the TSC, and the TSC, including the departing member, shall confirm or reject such nomination by a vote. In the event that the departing member's nomination for successor is rejected by vote of the TSC, the departing member shall be entitled to continue nominating successors until one such successor is confirmed by vote of the TSC. If the departing member fails or is unable to nominate a successor, the TSC may nominate one on the departing member's behalf.

TSC membership is presumed to be retained by the individual even if they change employers. The TSC may take action to ensure that organizational stakeholder representation not become severely disproportionate, for example by urging an organization that loses its sole TSC representative to nominate a new member, or to limit the total number of voting members from any one organization if too many members all move to the same organization.

### TSC Meetings

Any meetings of the TSC are intended to be open to the public, except where there is a reasonable need for privacy. The TSC meets regularly in a voice conference call, at a cadence deemed appropriate by the TSC. The TSC Chair moderates the meeting, or appoints another TSC member to moderate in his or her absence. Meetings may also be streamed online where appropriate; connection details will be posted to the Open RV-dev mail list in advance of the scheduled meeting.

Items are added to the TSC agenda which are considered contentious or are modifications of governance, contribution policy, TSC membership, or release process, in addition to topics involving the high-level technical direction of the project.

The intention of the agenda is not to approve or review all patches. That should happen continuously on GitHub and be handled by the larger group of Committers.

Any community member or Contributor can ask that something be reviewed by the TSC at the meeting by logging a GitHub issue. Any Committer, TSC member, or the meeting chair can bring the issue to the TSC's attention by applying the TSC label.

Prior to each TSC meeting, the meeting chair will share the agenda with members of the TSC. TSC members can also add items to the agenda at the beginning of each meeting. The meeting chair and the TSC cannot veto or remove items.

The TSC may invite additional persons to participate in a non-voting capacity.

The meeting chair is responsible for ensuring that minutes are taken and archived in the project repository.

Due to the challenges of scheduling a global meeting with participants in several time zones, the TSC will seek to resolve as many agenda items as possible outside of meetings on the public mailing list.
Loading

0 comments on commit 41eccbe

Please sign in to comment.