~ft/dav1d

dav1d/CONTRIBUTING.md -rw-r--r-- 2.0 KiB
6b5e8cc5Sigrid Solveig Haflínudóttir inline and unroll more 52 years ago

#dav1d contribution guide

#CoC

The VideoLAN Code of Conduct applies fully to this project.

#ToDo

The todo list can be found on the wiki.

#Codebase language

The codebase is developed with the following assumptions:

For the library:

  • C language with C99 version, without the VLA or the Complex (__STDC_NO_COMPLEX__) features, and without compiler extensions. Anonymous structures and unions are the only allowed compiler extensions for internal code.
  • x86 asm in .asm files, using the NASM syntax,
  • arm/arm64 in .S files, using the GAS syntax limited to subset llvm 5.0's internal assembler supports,
  • no C++ is allowed, whatever the version.

For the tools and utils:

  • C (see above for restrictions)
  • Rust
  • C++ is only allowed for the MFT.

If you want to use Threads or Atomic features, please conform to the C11/POSIX semantic and use a wrapper for older compilers/platforms (like done in VLC).

Please use modern standard POSIX functions (strscpy, asprintf, tdestroy), and provide a compatibility fallback (like done in VLC).

We will make reasonable efforts for compilers that are a bit older, but we won't support gcc 3 or MSVC 2012.

#Authorship

Please provide a correct authorship for your commit logs, with a name and a valid email.

We will reject anonymous contributions for now. As an exception, known pseudonyms from the multimedia community are accepted.

This project is respecting Copyright and Droit d'auteur. There is no copyright attribution or CLA.

#Commit logs

Please read How to Write a Git Commit Message.

#Submit requests (WIP)

  • Code,
  • Compile,
  • Check your code style,
  • Test,
  • Try,
  • Submit patches through merge requests,
  • Check that this passes the CI.

#Patent license

You need to read, understand, and agree to the AV1 patents license, before committing.