Skip to content

Commit 601c1b4

Browse files
authored
Updated issues template and added PR template (#315)
* added github issue template * updated issue template * updated ISSUE_TEMPLATE with friendlier wording and structure * added pr template * added branch notes
1 parent 7a51432 commit 601c1b4

File tree

2 files changed

+45
-18
lines changed

2 files changed

+45
-18
lines changed

β€Ž.github/ISSUE_TEMPLATE.mdβ€Ž

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,23 @@
1-
## Nature of issue?
1+
## β†’ Description πŸ“
22

3-
- [ ] Found a bug
4-
- [ ] Existing feature enhancement
5-
- [ ] New feature request
6-
- [ ] Other
3+
A clear and concise description of what the issue is about. Let us know if you:
74

5+
- found a bug πŸ›
6+
- want to suggest an update πŸ’‘
7+
- have an idea for a new feature πŸ†•
88

9-
***
10-
## Details about the Bug:
11-
> Please describe the bug you've encountered. Make sure to include the following information below.
129

13-
### Web browser and version: (e.g. Firefox version 65, Chrome version 71.0)
1410

15-
### Operating System: (e.g. MacOS, Windows, Ubuntu)
11+
## β†’ Screenshots πŸ–Ό
12+
(Any relevant screenshots, sketches, or helpful concept diagrams)
1613

17-
### Steps to reproduce this bug:
1814

19-
***
20-
## Existing Feature Enhancement details:
21-
> Please describe the feature enhancement you're hoping to see.
15+
## β†’ Helpful Information πŸ¦„
2216

17+
A list of relevant information for this issue. This will help people navigate the project and offer some clues of where to start. Depending on the nature of this issue, important and helpful information might include:
2318

24-
***
25-
26-
## New feature details:
27-
> Please describe the new feature you're hoping to see.
19+
- **Web browser and version** (e.g. Firefox version 65, Chrome version 71.0)
20+
- **Operating System** (e.g. MacOS, Windows, Ubuntu)
21+
- Steps to reproduce the issue
22+
- ml5 version you're using
23+
- Links to example code in the [p5 web editor](https://editor.p5js.org) or other online shareable code editor
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!-- MANY MANY THANKS FOR YOUR CONTRIBUTION. ML5 ❀️S YOU! -->
2+
## β†’ Submit changes to the relevant branch 🌲
3+
4+
We have 2 branches you can submit to, **development** or **release**. You'd make us so happy 😊 if you submitted your pull request to the branch that is most relevant for your submission.
5+
6+
- for pull requests related to **new features** πŸ†• make sure to use the **development** branch
7+
- for pull requests related to bug πŸ›fixes of the existing stable release, make sure your pull request goes to the **release** branch.
8+
9+
10+
## β†’ Description πŸ“
11+
12+
A clear and concise description of what the pull request is about. Let us know if you are:
13+
14+
- fixing a bug πŸ›
15+
- adding an update πŸ› 
16+
- submitting a new feature πŸ†•
17+
18+
## β†’ Screenshots πŸ–Ό
19+
(Any relevant screenshots, sketches, or helpful concept diagrams - these are helpful for our release notes and for getting people excited about your super cool feature and/or fix!)
20+
21+
22+
## β†’ Relevant Example or Paired Pull Request to [ml5-examples](https://github.com/ml5js/ml5-examples) πŸ¦„
23+
24+
In order to help the ml5 team understand your pull request, we ask that you please submit an example to [ml5-examples](https://github.com/ml5js/ml5-examples) showcasing how your integrated feature works. You're also welcome to show how this works by providing code that can be easily run by others.
25+
26+
## β†’ Relevant documentation 🌴
27+
28+
Write a few notes about your pull request. Document any functionality that might be helpful for others who want to run and test your changes. If we don't know how to make use of your contribution, we won't be able t integrate it! πŸ™
29+
30+
31+

0 commit comments

Comments
Β (0)