aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md34
-rw-r--r--README.md2
2 files changed, 27 insertions, 9 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 5f5ca9743..3092767fd 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,18 +1,36 @@
1<!-- Thank you for your Pull Request. -->
1<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> 2<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
2<!-- Please start by naming your pull request properly e.g. "Add Google Tasks to Todo providers". --> 3<!-- Please start by naming your pull request properly for e.g. "Add Google Tasks to Todo providers". -->
4<!-- Please keep in mind that any text inside "<!--" and "--\>" are comments from us and won't be visible in your bug report, so please don't put any text in them. -->
3 5
4### Description 6#### Pre-flight Checklist
7
81. Please remember that if you are logging a bug for some service that has *stopped working* or is *working incorrectly*, please log the bug [here](https://github.com/getferdi/recipes/issues)
92. If you are requesting support for a **new service** in Ferdi, please log it [here](https://github.com/getferdi/recipes/pulls)
103. Please remember to read the [self-help documentation](https://github.com/getferdi/ferdi#troubleshooting-recipes-self-help) - in case it helps you unblock yourself for issues related to older versions of recipes that were installed on your machine. (These will get automatically upgraded when you upgrade to the newer versions of Ferdi, but to get new recipes between Ferdi releases, this documentation is quite useful.)
114. Please consider supporting Ferdi!
12 👉 https://github.com/sponsors/getferdi
13 👉 https://opencollective.com/getferdi/donate
145. Please ensure you've completed all of the following.
15 - [ ] I have read the [Contributing Guidelines](https://github.com/getferdi/ferdi/blob/develop/CONTRIBUTING.md) for this project.
16 - [ ] I agree to follow the [Code of Conduct](https://github.com/getferdi/ferdi/blob/develop/CODE_OF_CONDUCT.md) that this project adheres to.
17 - [ ] I have searched the [issue tracker](https://github.com/getferdi/ferdi/issues) for a feature request that matches the one I want to file, without success.
18
19#### Description of Change
5<!-- Describe your changes in detail. --> 20<!-- Describe your changes in detail. -->
6 21
7### Motivation and Context 22#### Motivation and Context
8<!-- Why is this change required? What problem does it solve? --> 23<!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. -->
9<!-- If it fixes an open issue, please link to the issue here. -->
10 24
11### Screenshots 25#### Screenshots
12<!-- Remove the section if this does not apply. --> 26<!-- Remove the section if this does not apply. -->
13 27
14### Checklist: 28#### Checklist
15<!-- Go over all the following points, and put an `x` in all the boxes that apply. --> 29<!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->
16- [ ] My pull request is properly named 30- [ ] My pull request is properly named
17- [ ] The changes respect the code style of the project (`$ npm run lint && npm run reformat-files && npm run manage-translations && npm run apply-branding`) 31- [ ] The changes respect the code style of the project (`$ npm run lint && npm run reformat-files && npm run manage-translations && npm run apply-branding`)
32- [ ] `npm test` passes
18- [ ] I tested/previewed my changes locally 33- [ ] I tested/previewed my changes locally
34
35#### Release Notes
36<!-- Please add a one-line description for users of Ferdi to read in the release notes, or 'none' if no notes relevant to such users. Examples and help on special cases: https://github.com/electron/clerk/blob/master/README.md#examples -->
diff --git a/README.md b/README.md
index 587c3dd07..b3d4b685e 100644
--- a/README.md
+++ b/README.md
@@ -241,7 +241,7 @@ Nightly releases are automatically triggered every day ([details](https://github
241 241
242One of the issues being raised by the awesome users of Ferdi is that certain service-functionalities do not work. As good example of this is either the unread count (badge) stops working for specific services or the gmail logins don't work anymore. (These are just 2 of the most common problems reported). 242One of the issues being raised by the awesome users of Ferdi is that certain service-functionalities do not work. As good example of this is either the unread count (badge) stops working for specific services or the gmail logins don't work anymore. (These are just 2 of the most common problems reported).
243 243
244Since we (the contributors to Ferdi) also eat our own dog food, we use Ferdi as our day-to-day communication app - and most likely have faced the same/similar issue. As a first step before filing an issue, we request you to follow these simple steps to see if the issue gets fixed. 244Since we (the contributors to Ferdi) also eat our own dog food, we use Ferdi as our day-to-day communication app - and most likely have faced the same/similar issue. As a first step before filing an issue, we request you to follow these simple steps to see if the issue gets fixed. These recipes will get automatically upgraded when you upgrade to the newer versions of Ferdi, but to get new recipes **between** Ferdi releases, this documentation is quite useful.
245 245
246- Make sure you are on the latest version of Ferdi. As of this writing, since the nightly CI packaging process is broken, we request you to download the latest nightly from the link in [Nightly releases](#nightly-releases) section. 246- Make sure you are on the latest version of Ferdi. As of this writing, since the nightly CI packaging process is broken, we request you to download the latest nightly from the link in [Nightly releases](#nightly-releases) section.
247- Stop Ferdi 247- Stop Ferdi