djsundog/ffplayout
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
jb-alvarado 2024-03-21 10:23:20 +01:00 committed by GitHub
parent ab51f860b4
commit 8ea2853264
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
CONTRIBUTING.md
View File

@ -1,6 +1,6 @@
## Contribute to ffplayout ## Contribute to ffplayout
#### **Report a bug** ### Report a bug
- Check issues if the bug was already reported. - Check issues if the bug was already reported.
- When this bug was not reported, please use the **bug report** template. - When this bug was not reported, please use the **bug report** template.
@ -8,7 +8,7 @@
* use code blocks for config, log and command line parameters * use code blocks for config, log and command line parameters
* text from config and logging is preferred over screenshots * text from config and logging is preferred over screenshots
#### **Ask for help** ### Ask for help
When something is not working, you can feel free to ask your question under [discussions](https://github.com/ffplayout/ffplayout/discussions/categories/q-a). But please make some effort, so it makes it more easy to help. Please don't open discussion in a "WhatsApp style", with only one line of text. As a general rule of thumb answer this points: When something is not working, you can feel free to ask your question under [discussions](https://github.com/ffplayout/ffplayout/discussions/categories/q-a). But please make some effort, so it makes it more easy to help. Please don't open discussion in a "WhatsApp style", with only one line of text. As a general rule of thumb answer this points:
@ -19,11 +19,19 @@ When something is not working, you can feel free to ask your question under [dis
- relevant logging output - relevant logging output
- current configuration (ffplayout.yml) - current configuration (ffplayout.yml)
#### **Feature request** #### Sample files
If playout works normally on your system with the [provided test clips](https://github.com/ffplayout/ffplayout/tree/master/tests/assets/media_sorted), but your files produce errors and you are sure that the problem is related to ffplayout, you can provide a test file under these conditions:
- ffmpeg can process the file normally.
- The file is not too large, a few seconds should be enough.
- The video doesn't contain any illegal content.
- You have legal permission to distribute the file.
- The content is not age restricted (no violent or sexual content).
### Feature request
You can ask for features, but it can not be guaranteed that this will find its way to the code basis. Try to think if your idea is useful for others to and describe it in a understandable way. If your idea is accepted, it can take time until it will be apply. In general stability goes over features, and when just a new version has arrived, it can take time to prove itself in production. You can ask for features, but it can not be guaranteed that this will find its way to the code basis. Try to think if your idea is useful for others to and describe it in a understandable way. If your idea is accepted, it can take time until it will be apply. In general stability goes over features, and when just a new version has arrived, it can take time to prove itself in production.
#### **Create a pull request** ### Create a pull request
In general pull requests are very welcome! But please don't create features, which are to specific and helps only your use case and no one else. If your are not sure, better ask before you start. In general pull requests are very welcome! But please don't create features, which are to specific and helps only your use case and no one else. If your are not sure, better ask before you start.