Browse Source

New issue templates (with prompt)

Albin Larsson 1 year ago
parent
commit
ad1989e45e

+ 55
- 0
.github/ISSUE_TEMPLATE/bug.md View File

@@ -0,0 +1,55 @@
1
+---
2
+name: Bug report
3
+about: Report an issue or unexpected behaviour with Plyr
4
+---
5
+
6
+<!--
7
+
8
+Before creating the issue, please make sure that...
9
+
10
+* You aren't getting any errors in your own code, causing the problem.
11
+* You are using the latest version of Plyr.
12
+* There isn't already an open issue for your problem.
13
+* You are following the documentation correctly (https://github.com/sampotts/plyr/)
14
+* Your problem doesn't happen if you remove Plyr and use native HTML5 media (when applicable).
15
+
16
+For problems with autoplay, see our FAQ (https://github.com/sampotts/plyr/wiki/FAQ)
17
+
18
+If you have multiple unrelated problems, create separate issues rather than combining them into one.
19
+
20
+Note that leaving sections blank or being vague will make it difficult for us to troubleshoot and we may close the issue.
21
+-->
22
+
23
+### Expected behaviour
24
+
25
+### Actual behaviour
26
+
27
+### Steps to reproduce
28
+
29
+### Environment
30
+
31
+- Browser:
32
+- Version:
33
+- Operating System:
34
+- Version:
35
+
36
+### Console errors (if any)
37
+
38
+### Link to where the bug is happening
39
+
40
+<!--
41
+This link can be either to our demo at https://plyr.io/ if the problem can be observed there, or to a code playground with a **minimal** test case that demonstrates the problem.
42
+
43
+You can use one of our prepared templates to get started creating the test case:
44
+
45
+* HTML5 video: https://codepen.io/pen?template=bKeqpr
46
+* HTML5 audio: https://codepen.io/pen?template=rKLywR
47
+* YouTube: https://codepen.io/pen?template=GGqbbJ
48
+* Vimeo: https://codepen.io/pen?template=bKeXNq
49
+* Dash.js integration: https://codepen.io/pen?template=zaBgBy
50
+* Hls.js integration: https://codepen.io/pen?template=oyLKQb
51
+* Shaka Player integration: https://codepen.io/pen?template=ZRpzZO
52
+
53
+It's important that you keep the issue description and replication demo **minimal**. If your replication includes frameworks, libraries or customizations, this makes it much harder to understand the problem and find the bug. For more help on how to create the demo, see https://github.com/sampotts/plyr/wiki/Writing-helpful-issue-descriptions
54
+
55
+-->

+ 10
- 0
.github/ISSUE_TEMPLATE/feature.md View File

@@ -0,0 +1,10 @@
1
+---
2
+name: New feature
3
+about: Request new functionality
4
+---
5
+
6
+<!--
7
+Please describe the behaviour that you want to add, and why. Be as clear as possible to avoid confusion.
8
+
9
+If you want to request multiple features that aren't directly related, then create one issue per feature.
10
+-->

+ 10
- 0
.github/ISSUE_TEMPLATE/improvement.md View File

@@ -0,0 +1,10 @@
1
+---
2
+name: Improvement
3
+about: Request a change that isn't a bug or new feature
4
+---
5
+
6
+<!--
7
+Please describe the behaviour that you want to change, and why. Be as clear as possible to avoid confusion.
8
+
9
+If you want to request multiple changes that aren't directly related, then create one issue per change.
10
+-->

+ 2
- 14
.github/issue_template.md View File

@@ -1,15 +1,3 @@
1
-*Please _use this issue template_ as it makes replicating and fixing the issue easier for us. If you decide not to use it or you are vague your issue may be close instantly.*
1
+PLEASE USE OUR SPECIFIC ISSUE TEMPLATES for bug reports, features and improvement suggestions.
2 2
 
3
-### Expected behaviour
4
-
5
-### Actual behaviour
6
-
7
-### Environment
8
-
9
-- Browser:
10
-- Version:
11
-- Operating System:
12
-- Version:
13
-
14
-### Steps to reproduce
15
--
3
+Our issue tracker is not for support questions. If you need help, follow our support instructions: https://github.com/sampotts/plyr/blob/master/contributing.md#support

+ 13
- 34
contributing.md View File

@@ -2,50 +2,29 @@
2 2
 
3 3
 We welcome bug reports, feature requests and pull requests. If you want to help us out, please follow these guidelines, in order to avoid redundant work.
4 4
 
5
-## Commenting
6
-When commenting, keep a civil tone and stay on topic. Don't ask for support (use [Stack Overflow](https://stackoverflow.com/) or [our Slack](https://bit.ly/plyr-chat) for that), or post "+1" or "I agree" type of comments. Use the emojis instead.
7
-
8
-Asking for the status on issues is discouraged. Unless someone has explicitly said in an issue that it's work in progress, most likely that means no one is working on it. We have a lot to do, and it may not be a top priority for us.
9
-
10
-We *may* moderate discussions. We do this to avoid threads being "hijacked", to avoid confusion in case the content is misleading or outdated, and to avoid bothering people with github notifications.
11
-
12
-## Reporting issues
13
-
14
-Our GitHub issue tracker is for bug reports and feature requests. Don't ask for support here. Use [Stack Overflow](https://stackoverflow.com/) or [our Slack](https://bit.ly/plyr-chat) for that.
15
-
16
-Please verify that your issue hasn't already been answered by our [FAQ](https://github.com/sampotts/plyr/wiki/FAQ), and that there isn't already an open issue for it.
5
+## Support
17 6
 
18
-When applicable, check that your problem doesn't happen without Plyr (see [FAQ#1](https://github.com/sampotts/plyr/wiki/FAQ#1-does-plyr-work-with--)).
7
+Before asking questions, read our [documentation](https://github.com/sampotts/plyr) and [FAQ](https://github.com/sampotts/plyr/wiki/FAQ).
19 8
 
20
-Verify that you are following the documentation, are using the latest version of Plyr, and aren't getting any errors in your own code, causing the issues.
9
+If these doesn't answer your question
10
+* Use [Stack Overflow](https://stackoverflow.com/) for questions that doesn't directly involve Plyr. This includes for example how to use Javascript, CSS or HTML5 media in general, and how to use other frameworks, libraries and technology.
11
+* Use [our Slack](https://bit.ly/plyr-chat) if you need help using Plyr or have questions about Plyr.
21 12
 
22
-Create one issue per problem or request (i.e. don't combine multiple problems to one git issue). Describe the issue as detailed as possible (see [Replication](#replication))
23
-
24
-## Replication
25
-
26
-In order to solve a problem, we first need to understand it. Please answer these questions when reporting issues or asking for help in [our Slack](https://bit.ly/plyr-chat).
27
-
28
-* Does it happen only with specific options and/or specific browsers?
29
-* Does is happen only with HTML5 video, audio, YouTube, Vimeo or a specific library?
30
-* Does the issue happen on [our demo](https://plyr.io/)? If not, please recreate it with a **minimal** example online. You can use our Codepen templates to get started:
31
-  * [HTML5 video](https://codepen.io/pen?template=bKeqpr)
32
-  * [HTML5 audio](https://codepen.io/pen?template=rKLywR)
33
-  * [YouTube](https://codepen.io/pen?template=GGqbbJ)
34
-  * [Vimeo](https://codepen.io/pen?template=bKeXNq)
35
-  * [Dash.js integration](https://codepen.io/pen?template=zaBgBy)
36
-  * [Hls.js integration](https://codepen.io/pen?template=oyLKQb)
37
-  * [Shaka Player integration](https://codepen.io/pen?template=ZRpzZO)
13
+## Commenting
14
+When commenting, keep a civil tone and stay on topic. Don't ask for [support](#support), or post "+1" or "I agree" type of comments. Use the emojis instead.
38 15
 
39
-It's important that you keep the issue description and replication demo **minimal**. If your replication includes frameworks, libraries or customizations, this makes it harder to debug and understand the issue. While it may be relevant to bring this up (ex: "I need Plyr to trigger the event sooner or it breaks Framework X"), please keep these out of your replication demo if they aren't strictly needed to reproduce the issue. If the issue is caused by something a library does that Plyr doesn't handle, it's more helpful for us if you find out what it is, and replicate the same problem without the library. Otherwise any developer who is willing to help out with the issue has to understand the frameworks, libraries and customizations of *your* choice, or no one will try to fix your issue because it's too much work.
16
+Asking for the status on issues is discouraged. Unless someone has explicitly said in an issue that it's work in progress, most likely that means no one is working on it. We have a lot to do, and it may not be a top priority for us.
40 17
 
41
-## Requesting features and improvements
18
+We *may* moderate discussions. We do this to avoid threads being "hijacked", to avoid confusion in case the content is misleading or outdated, and to avoid bothering people with github notifications.
42 19
 
43
-If you are missing something in Plyr, you can create a GitHub issue for this as well. Since we prioritize fixing bugs first, and may have a lot of other suggestions and architectural changes to work on as well, these may not be at the top of our list. 
20
+## Creating issues
44 21
 
45
-If your suggestion is important or urgent to you, you may want to first ensure it's something we want to have in Plyr, and then contribute it as a pull request. [Our Slack](https://bit.ly/plyr-chat) is the best place for questions like this.
22
+Please follow the instructions in our issue templates. Don't use github issues to ask for [support](#support).
46 23
 
47 24
 ## Contributing features and documentation
48 25
 
26
+* If you want to add a feature or make critical changes, you may want to ensure that this is something we also want (so you don't waste your time). Ask us about this in the corresponding issue if there is one, or on [our Slack](https://bit.ly/plyr-chat) otherwise.
27
+
49 28
 * Fork Plyr, and create a new branch in your fork, based on the **develop** branch
50 29
 
51 30
 * To test locally, you can use the demo. First make sure you have installed the dependencies with `npm install` or `yarn`. Run `gulp` to build while you are working, and run a local server from the repository root directory. If you have Python installed, this command should work: `python -m SimpleHTTPServer 8080`. Then go to `http://localhost:8080/demo/`