ref: dd961b1e9febfd126fbc1422b984058a4409489d
parent: 6b3770ae629347f7548cced5bf4805adade8b7fe
author: Jean-Baptiste Kempf <jb@videolan.org>
date: Sat Dec 15 07:47:41 EST 2018
Update slightly the contribution document.
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,11 +1,11 @@
# dav1d contribution guide
## CoC
-The [VideoLAN Code of Conduct](https://wiki.videolan.org/CoC) applies to this project.
+The [VideoLAN Code of Conduct](https://wiki.videolan.org/CoC) applies fully to this project.
## ToDo
-Todo list can be found [on the wiki](https://code.videolan.org/videolan/dav1d/wikis/task-list).
+The todo list can be found [on the wiki](https://code.videolan.org/videolan/dav1d/wikis/task-list).
## Codebase language
@@ -20,7 +20,7 @@
For the tools and utils:
- C *(see above for restrictions)*
- Rust
-- C++ only for the MFT.
+- 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)*.
@@ -42,12 +42,15 @@
## Submit requests (WIP)
-- Code
-- Check [code style](https://code.videolan.org/videolan/dav1d/wikis/Coding-style)
-- Test
-- Try
-- Submit patches
+- 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.
+