Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/videolan/dav1d.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJean-Baptiste Kempf <jb@videolan.org>2018-12-15 14:47:41 +0300
committerJean-Baptiste Kempf <jb@videolan.org>2018-12-15 14:47:41 +0300
commitdd961b1e9febfd126fbc1422b984058a4409489d (patch)
tree06974c670c860a28a6070a3619d3ff3396817f88 /CONTRIBUTING.md
parent6b3770ae629347f7548cced5bf4805adade8b7fe (diff)
Update slightly the contribution document.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md19
1 files changed, 11 insertions, 8 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b958b63..347741f 100644
--- 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 library:
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 @@ Please read [How to Write a Git Commit Message](https://chris.beams.io/posts/git
## 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.
+