Skip to content

Commit

Permalink
Tweak to main index. (#99)
Browse files Browse the repository at this point in the history
  • Loading branch information
richardssam and SamRichardsDisney authored Aug 18, 2024
1 parent 3a75b36 commit 4ca7a2d
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 1 deletion.
1 change: 1 addition & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The ORI Encoding Guidelines project abides by Linux Foundation's code of conduct, which you can read in full at https://lfprojects.org/policies/code-of-conduct.
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contributing to the ORI Encoding Guidelines

## Get Connected.

Please reach out to us, particularly if you are having a problem, since its likely somebody else is sharing that problem, and if we have not documented it, it may be something that needs to be updated.

Reach out using one of the following approaches:
* ASWF Slack - [#open-review-initiative](#open-review-initiative)
* [Github ORI Encoding Guidelines - discussions ](https://github.com/AcademySoftwareFoundation/EncodingGuidelines/discussions)
* If there are particular issues - [Github Issues](https://github.com/AcademySoftwareFoundation/EncodingGuidelines/issues)


## Documentation Style

We are attempting to do all the documentation using markdown, in particular using [Just-the-docs](https://github.com/just-the-docs/just-the-docs), we would encourage new documentation to be done using that format.

## Coding Style

The test suite has been developed using python-3, and has been designed to work on windows, osx and linux.

## How to Contribute a Bug Fix or Change or additional Documentation

To contribute code to the project, first read over the [governance policies] page to understand the roles involved.

ORI Encoding Guidelines is licensed under the [Apache License 2.0](LICENSE.md) license. Contributions should abide by that standard license.

Project committers will review the contribution in a timely manner, and advise of any changes needed to merge the request.


[governance policies]: GOVERNANCE.md
[copyright and license headers]: https://github.com/AcademySoftwareFoundation/tac/blob/main/process/contribution_guidelines.md#license
[Developer Certificate of Origin signoff]: https://github.com/AcademySoftwareFoundation/tac/blob/main/process/contribution_guidelines.md#contribution-sign-off
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ We welcome suggestions and improvements.
The main confluence page for this for now is [here](https://wiki.aswf.io/pages/viewpage.action?pageId=16031068)

{: .highlight }
We would like to encourage the usage of [VP9](EncodeVP9.html) and [AV1](EncodeAv1.html) to encourage the usage of patent-free codecs, for more information on this see the white-paper [Next-gen codecs for VFX Community](https://docs.google.com/document/d/1EJ7Q_HhjL0ELNdjz5AgnPrraUvy7XCo52LL08WxgjtA/edit#heading=h.9rkn78tjmq48).
We recommend usage of [VP9](EncodeVP9.html) and [AV1](EncodeAv1.html) over h264 and h265 where possible to encourage the usage of patent-free codecs, for more information on this see the white-paper [Next-gen codecs for VFX Community](https://docs.google.com/document/d/1EJ7Q_HhjL0ELNdjz5AgnPrraUvy7XCo52LL08WxgjtA/edit#heading=h.9rkn78tjmq48).


## Why is this needed.
Expand Down

0 comments on commit 4ca7a2d

Please sign in to comment.