CONTRIBUTING.md

# dav1d contribution guide

## CoC
The [VideoLAN Code of Conduct](https://wiki.videolan.org/CoC) applies fully to this project.

## ToDo

The todo list can be found [on the wiki](https://code.videolan.org/videolan/dav1d/wikis/task-list).

## 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](https://chris.beams.io/posts/git-commit/).

## Submit requests (WIP)

- Code,
- [Compile](https://xkcd.com/303/),
- Check your [code style](https://code.videolan.org/videolan/dav1d/wikis/Coding-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](doc/PATENTS), before committing.
Fix non-lowercase references to dav1d 2018-09-26 16:00:15 -04:00			`# dav1d contribution guide`
Initial commit for dav1d 2018-09-04 22:23:33 +02:00
			`## CoC`
Update slightly the contribution document. 2018-12-15 12:47:41 +01:00			`The [VideoLAN Code of Conduct](https://wiki.videolan.org/CoC) applies fully to this project.`
Initial commit for dav1d 2018-09-04 22:23:33 +02:00
Update CONTRIBUTING.md for TODO 2018-09-27 11:35:05 +02:00			`## ToDo`

Update slightly the contribution document. 2018-12-15 12:47:41 +01:00			`The todo list can be found [on the wiki](https://code.videolan.org/videolan/dav1d/wikis/task-list).`
Update CONTRIBUTING.md for TODO 2018-09-27 11:35:05 +02:00
Initial commit for dav1d 2018-09-04 22:23:33 +02:00			`## Codebase language`

			`The codebase is developed with the following assumptions:`

			`For the library:`
contributing: document the allowed internal use of anonymous structs/unions 2020-08-22 10:27:44 +02:00			`- 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.`
arm: document arm asm rules 2018-09-20 19:31:50 +00:00			`- 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,`
Initial commit for dav1d 2018-09-04 22:23:33 +02:00			`- no C++ is allowed, whatever the version.`

			`For the tools and utils:`
			`- C (see above for restrictions)`
			`- Rust`
Update slightly the contribution document. 2018-12-15 12:47:41 +01:00			`- C++ is only allowed for the MFT.`
Initial commit for dav1d 2018-09-04 22:23:33 +02:00
			`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](https://chris.beams.io/posts/git-commit/).`

			`## Submit requests (WIP)`

Update slightly the contribution document. 2018-12-15 12:47:41 +01:00			`- Code,`
			`- [Compile](https://xkcd.com/303/),`
			`- Check your [code style](https://code.videolan.org/videolan/dav1d/wikis/Coding-style),`
			`- Test,`
			`- Try,`
			`- Submit patches through merge requests,`
			`- Check that this passes the CI.`
Initial commit for dav1d 2018-09-04 22:23:33 +02:00
			`## Patent license`

Add the word agree to contributor agreement. 2018-09-22 09:19:12 +00:00			`You need to read, understand, and agree to the [AV1 patents license](doc/PATENTS), before committing.`
Update slightly the contribution document. 2018-12-15 12:47:41 +01:00