Skip to content

Commit 450ee51

Browse files
committed
Adopt issue templates
1 parent ee22d24 commit 450ee51

3 files changed

Lines changed: 90 additions & 0 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## Submitting bugs
2+
Please include the following information to help us reproduce and fix:
3+
4+
* What you did
5+
* What you expected to happen
6+
* What actually happened
7+
* Browser and version
8+
* Example code that reproduces the problem (if possible)
9+
* *(l33t mode)* A failing test
10+
11+
## Making contributions
12+
Want to be listed as a *Contributor*? Make a pull request with:
13+
14+
* Unit and/or functional tests that validate changes you're making.
15+
* Run unit tests in the latest IE, Firefox, Chrome, Safari and Opera and make sure they pass.
16+
* Rebase your changes onto origin/HEAD if you can do so cleanly.
17+
* If submitting additional functionality, provide an example of how to use it.
18+
* Please keep code style consistent with surrounding code.
19+
20+
## Dev Setup
21+
* Make sure you have [NodeJS v16.x](https://nodejs.org/) installed
22+
* Run `npm ci` from the project directory
23+
24+
## Linting
25+
* Run `npm run lint` to run ESLint
26+
27+
## Testing
28+
* (Local) Run `npm test`. Make sure [Karma Local Config](karma.conf.js) has the browsers you want
29+
* (Any browser, remotely) If you have a [Sauce Labs](https://saucelabs.com) account, you can run `npm run test-ci`
30+
Make sure the target browser is enabled in [Karma CI Config](karma.conf.ci.js)
31+
Otherwise, GitHub Actions will run all browsers if you submit a Pull Request.
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: a:bug
6+
assignees: ''
7+
8+
---
9+
10+
<!--- Provide a general summary of the issue in the title above -->
11+
12+
## Expected Behavior
13+
<!--- If you're describing a bug, tell us what should happen -->
14+
<!--- If you're suggesting a change/improvement, tell us how it should work -->
15+
16+
## Current Behavior
17+
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
18+
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
19+
20+
## Steps to Reproduce (for bugs)
21+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
22+
<!--- reproduce this bug. Include code to reproduce, if relevant -->
23+
24+
## Context
25+
<!--- How has this issue affected you? What are you trying to accomplish? -->
26+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
27+
28+
## Your Environment
29+
<!--- Include as many relevant details about the environment you experienced the bug in -->
30+
* Package version:
31+
* Browser name and version:
32+
* OS version (desktop or mobile):
33+
* Link to your project:
34+
35+
## Possible Solution
36+
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
37+
<!--- or ideas how to implement the addition or change -->
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: a:feature
6+
assignees: ''
7+
8+
---
9+
10+
<!--- Provide a general summary of the issue in the title above -->
11+
12+
## Expected Behavior
13+
<!--- If you're describing a bug, tell us what should happen -->
14+
<!--- If you're suggesting a change/improvement, tell us how it should work -->
15+
16+
## Context
17+
<!--- How has this issue affected you? What are you trying to accomplish? -->
18+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
19+
20+
## Possible Solution
21+
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
22+
<!--- or ideas how to implement the addition or change -->

0 commit comments

Comments
 (0)