diff options
author | Amine <amine@mouafik.fr> | 2020-05-11 07:49:50 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-05-11 07:49:50 +0000 |
commit | 951485403e90853b9043b7a1c729995ab062878f (patch) | |
tree | ba07afde7c4831ebf01a25cdc1c4a13d00bcf093 | |
parent | Remove confusing reference to yarn in GitHub pull request template (#725) (diff) | |
download | ferdium-app-951485403e90853b9043b7a1c729995ab062878f.tar.gz ferdium-app-951485403e90853b9043b7a1c729995ab062878f.tar.zst ferdium-app-951485403e90853b9043b7a1c729995ab062878f.zip |
Review GitHub issues/pull requests templates (#732)
-rw-r--r-- | .github/FEATURE_PROPOSAL_TEMPLATE.md | 14 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE.md | 36 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 34 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 3 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/open_issue.md | 8 | ||||
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 32 |
6 files changed, 33 insertions, 94 deletions
diff --git a/.github/FEATURE_PROPOSAL_TEMPLATE.md b/.github/FEATURE_PROPOSAL_TEMPLATE.md deleted file mode 100644 index e8cdd41ed..000000000 --- a/.github/FEATURE_PROPOSAL_TEMPLATE.md +++ /dev/null | |||
@@ -1,14 +0,0 @@ | |||
1 | <!--- Provide a general summary of your changes in the Title above --> | ||
2 | |||
3 | ### Feature Description | ||
4 | <!--- Describe your feature in detail --> | ||
5 | |||
6 | ### Motivation and Context | ||
7 | <!--- | ||
8 | * Why is this change required? | ||
9 | * How is this improving the Ferdi experience? | ||
10 | * What problem does it solve? | ||
11 | --> | ||
12 | |||
13 | ### Mockups, Screenshots (if available): | ||
14 | <!--- A picture says more than a thousand words. --> | ||
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index c0ce853ae..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null | |||
@@ -1,36 +0,0 @@ | |||
1 | <!--- Provide a general summary of the issue in the Title above --> | ||
2 | |||
3 | <!-- This repository is only for the Ferdi client. Please use this form ( https://bitly.com/franz-service-request ) for service requests or check out the guide ( https://github.com/meetfranz/plugins ) to create your own service integration. --> | ||
4 | |||
5 | <!--- If you want to propose a feature, use this template: https://raw.githubusercontent.com/meetfranz/franz/master/.github/FEATURE_PROPOSAL_TEMPLATE.md --> | ||
6 | |||
7 | ### Expected Behavior | ||
8 | <!--- If you're describing a bug, tell us what should happen --> | ||
9 | <!--- If you're suggesting a change/improvement, tell us how it should work --> | ||
10 | |||
11 | ### Current Behavior | ||
12 | <!--- If describing a bug, tell us what happens instead of the expected behavior --> | ||
13 | <!--- If suggesting a change/improvement, explain the difference from current behavior --> | ||
14 | |||
15 | ### Screenshots (if appropriate): | ||
16 | |||
17 | ### Possible Solution | ||
18 | <!--- Not obligatory, but suggest a fix/reason for the bug, --> | ||
19 | <!--- or ideas how to implement the addition or change --> | ||
20 | |||
21 | ### Steps to Reproduce (for bugs) | ||
22 | <!--- Provide a link to a live example, or an unambiguous set of steps to --> | ||
23 | <!--- reproduce this bug. Include code to reproduce, if relevant --> | ||
24 | 1. | ||
25 | 2. | ||
26 | 3. | ||
27 | 4. | ||
28 | |||
29 | ### Context | ||
30 | <!--- How has this issue affected you? What are you trying to accomplish? --> | ||
31 | <!--- Providing context helps us come up with a solution that is most useful in the real world --> | ||
32 | |||
33 | ### Your Environment | ||
34 | <!--- Include as many relevant details about the environment you experienced the bug in --> | ||
35 | * Ferdi Version used: | ||
36 | * Operating System and version: | ||
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index e206b128f..efad9f6a2 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md | |||
@@ -8,12 +8,11 @@ Please fill our form below, this way we can analyse and fix the problem as fast | |||
8 | Please keep in mind that any text inside "<!--" and "--\>" are comments from us and won't be | 8 | Please keep in mind that any text inside "<!--" and "--\>" are comments from us and won't be |
9 | visible in your bug report, so please don't put any text in them. | 9 | visible in your bug report, so please don't put any text in them. |
10 | --> | 10 | --> |
11 | **Describe the bug** | 11 | **Bug description:** |
12 | <!-- Add a clear and concise description of what the bug is --> | 12 | <!-- Add a clear and concise description of what the bug is --> |
13 | 13 | ||
14 | **To Reproduce** | 14 | **Steps to reproduce:** |
15 | <!-- Explain to us how we can reproduce your bug on our computer --> | 15 | <!-- Explain to us how we can reproduce your bug on our computer --> |
16 | Steps to reproduce the behavior: | ||
17 | 16 | ||
18 | 1. Go to '...' | 17 | 1. Go to '...' |
19 | 2. Click on '....' | 18 | 2. Click on '....' |
@@ -27,27 +26,18 @@ Steps to reproduce the behavior: | |||
27 | <!-- If applicable, add screenshots to help explain your problem. --> | 26 | <!-- If applicable, add screenshots to help explain your problem. --> |
28 | <!-- You can simply drag and drop any image file into the editor to add it to the report --> | 27 | <!-- You can simply drag and drop any image file into the editor to add it to the report --> |
29 | 28 | ||
30 | **Desktop:** | 29 | **Environment:** |
31 | 30 | ||
32 | - OS: [e.g. macOS, Windows 10 etc.] | 31 | - Operating System: <!-- e.g. macOS Catalina, Windows 10, etc. --> |
33 | - Ferdi Version [e.g. 5.4.3] | 32 | - Ferdi Version: <!-- e.g. 5.4.3 --> |
34 | <!-- ℹ You can find Ferdi's version by opening File > About Ferdi or Help > About Ferdi, depending on your Operating System --> | 33 | - Server: <!-- e.g. Ferdi, Franz, Using without an account --> |
35 | - Server Used: [e.g. https://api.getferdi.com] | ||
36 | <!-- ℹ You can find Ferdi's server in Ferdi's settings under "Server". If you self-host or use Ferdi without an account please say so. --> | ||
37 | 34 | ||
35 | - Debug information: | ||
38 | <!-- | 36 | <!-- |
39 | If you are using Ferdi >= 5.4.4-beta.2 please publish your debugging information and share them in your bug report. | 37 | Get your debug information via Ferdi "Help" menu ("Copy/Publish Debug Information") then |
40 | To publish a bug report, inside Ferdi's menu bar click on "Help" > "Publish debug information", accept our terms | 38 | share a debug information file or your published link with us. |
41 | and copy the link given to you. | ||
42 | --> | 39 | --> |
43 | Debug information: https://debug.getferdi.com/... | ||
44 | 40 | ||
45 | **Additional context** | 41 | <!-- Please consider supporting Ferdi! |
46 | <!-- Add any other context about the problem here. --> | 42 | 👉 https://github.com/sponsors/getferdi |
47 | 43 | 👉 https://opencollective.com/getferdi/donate --> | |
48 | <!-- | ||
49 | Love Ferdi? Please consider supporting our open-collective: | ||
50 | 👉 https://opencollective.com/getferdi/donate | ||
51 | or following us on Twitter: | ||
52 | 👉 https://twitter.com/getferdi | ||
53 | --> | ||
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 5535496d2..61353797c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md | |||
@@ -15,5 +15,6 @@ A clear and concise description of any alternative solutions or features you've | |||
15 | **Additional context** | 15 | **Additional context** |
16 | Add any other context or screenshots about the feature request here. | 16 | Add any other context or screenshots about the feature request here. |
17 | 17 | ||
18 | <!-- Love Ferdi? Please consider supporting our collective: | 18 | <!-- Please consider supporting Ferdi! |
19 | 👉 https://github.com/sponsors/getferdi | ||
19 | 👉 https://opencollective.com/getferdi/donate --> | 20 | 👉 https://opencollective.com/getferdi/donate --> |
diff --git a/.github/ISSUE_TEMPLATE/open_issue.md b/.github/ISSUE_TEMPLATE/open_issue.md new file mode 100644 index 000000000..c7c279643 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/open_issue.md | |||
@@ -0,0 +1,8 @@ | |||
1 | --- | ||
2 | name: Open issue | ||
3 | about: For everything that's neither a feature request, nor a bug | ||
4 | --- | ||
5 | |||
6 | <!-- Please consider supporting Ferdi! | ||
7 | 👉 https://github.com/sponsors/getferdi | ||
8 | 👉 https://opencollective.com/getferdi/donate --> | ||
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index aa6f850de..5a6f95002 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md | |||
@@ -1,28 +1,18 @@ | |||
1 | <!--- Provide a general summary of your changes in the Title above --> | 1 | <!-- 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". --> | ||
2 | 3 | ||
3 | ### Description | 4 | ### Description |
4 | <!--- Describe your changes in detail --> | 5 | <!-- Describe your changes in detail. --> |
5 | 6 | ||
6 | ### Motivation and Context | 7 | ### Motivation and Context |
7 | <!--- Why is this change required? What problem does it solve? --> | 8 | <!-- Why is this change required? What problem does it solve? --> |
8 | <!--- 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. --> |
9 | 10 | ||
10 | ### How Has This Been Tested? | 11 | ### Screenshots |
11 | <!--- Please describe in detail how you tested your changes. --> | 12 | <!-- Remove the section if this does not apply. --> |
12 | <!--- Include details of your testing environment, tests ran to see how --> | ||
13 | <!--- your change affects other areas of the code, etc. --> | ||
14 | |||
15 | ### Screenshots (if appropriate): | ||
16 | |||
17 | ### Types of changes | ||
18 | <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> | ||
19 | - [ ] Bug fix (non-breaking change which fixes an issue) | ||
20 | - [ ] New feature (non-breaking change which adds functionality) | ||
21 | - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||
22 | 13 | ||
23 | ### Checklist: | 14 | ### Checklist: |
24 | <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> | 15 | <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> |
25 | <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> | 16 | - [ ] My pull request is properly named |
26 | - [ ] My code follows the code style of this project (run `$ npm run lint`). | 17 | - [ ] The changes respect the code style of the project (`$ npm run lint`) |
27 | <!---- [ ] My change requires a change to the documentation. | 18 | - [ ] I tested/previewed my changes locally \ No newline at end of file |
28 | - [ ] I have updated the documentation accordingly. --> | ||