From 0483399762972fc25e4196f798de817377f96609 Mon Sep 17 00:00:00 2001 From: DARKDRAGON532 <69623818+DARKDRAGON532@users.noreply.github.com> Date: Sun, 28 Nov 2021 03:46:23 +0530 Subject: [PATCH 1/2] added contributing.md and faq.md --- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ FAQ.md | 18 ++++++++++++++++++ README.md | 6 ++++-- 3 files changed, 47 insertions(+), 2 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 FAQ.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..19b8989 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Welcome To Return YouTube Dislikes contributing guide + +Thank you for investing your time in contributing to our project! All your changes will be reflected in the next version of the extension (or the [website](https://www.returnyoutubedislike.com/)). + +## Getting Started +Please use Prettier with default settings for formatting. +### Issues +#### Opening a new issue +If you have any issues with the extension, please search to make sure the issue isn't already reported. If it isn't, open an issue, using the issue form is highly recommended but not mandatory. + +#### Solving an issue +If you found an issue that you feel you might be able to solve, don't be shy. Open a PR with the fix and make sure to mention the issue you are fixing. + +### Feature Request +#### Opening a new feature request +If you have an idea for the extension, feel free to open a feature request, but please search it before to make sure the feature isn't already suggested. Using the feature form is highly recommended but not mandatory + +#### Implementing a feature request +If you found a feature that you feel you might be able to implement, don't be shy. Open a PR with the fix and make sure to mention the feature you are implementing. + +### What PRs do we accept? +- Issue fixes. +- Feature implementation. +- Typos or better and easier words to use. +- Website contribution. \ No newline at end of file diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 0000000..0192501 --- /dev/null +++ b/FAQ.md @@ -0,0 +1,18 @@ +# Frquently Asked Questions +## Before asking a question on GitHub or Discord, please refer to this. + +### **1. Where does extension get data?** +Combination of GoogleAPI data and scraped data. + +We save all available data to our DB for it to be available after google shuts down dislike counts in their API. + +### **2. Video dislike count doesn't update** +Right now video dislikes are cached, and arent updated very frequenly. Once in 2-3 days, not more often. + +Yeah, it's not ideal, but it is what it is. Working on improving how often we can update them. + +### **3. How does this work?** +The extension collects the video id of the video you are watching, fetches the dislike (and other fields like views, likes etc) using our API, if this is the first time the video was fetched by our API, it will use the YouTube API to get the data, then stores the data in a database for caching (cached for around 2-3 days) and archiving purposes and returns it to you. The extension then displays the dislikes to you. + +### **4. What will happen after the YouTube API stops returning the dislike count?** +The backend will switch to using a combination of archived dislike stats, estimates extrapolated from extension user data and estimates based on view/like ratios for videos whose dislikes weren't archived and for outdated dislike archives. diff --git a/README.md b/README.md index 70835e0..f165206 100644 --- a/README.md +++ b/README.md @@ -30,13 +30,15 @@ This plugin will re-enable the visibility of the dislike count, fetching the tot With the removal of dislike stats from the YouTube API, our backend will switch to using a combination of scraped dislike stats, estimates extrapolated from extension user data and estimates based on view\like ratios. +[FAQ](https://github.com/Anarios/return-youtube-dislike/blob/main/FAQ.md) + ## Why it Matters You can learn more at our website at: [returnyoutubedislike.com](https://www.returnyoutubedislike.com/) -## Contribution guide +## Contributing -Please use Prettier with default settings for formatting +Please read the [contribution guide.](https://github.com/Anarios/return-youtube-dislike/blob/main/CONTRIBUTION.md) ## Donate From 6cb10ac485592372dec3af32a742b1f4babe418f Mon Sep 17 00:00:00 2001 From: DARKDRAGON532 <69623818+DARKDRAGON532@users.noreply.github.com> Date: Sun, 28 Nov 2021 03:50:19 +0530 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 19b8989..607bb00 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,4 +22,4 @@ If you found a feature that you feel you might be able to implement, don't be sh - Issue fixes. - Feature implementation. - Typos or better and easier words to use. -- Website contribution. \ No newline at end of file +- Website contributions.