Skip to content

Commit 8d4abf4

Browse files
jchwengerjoeyklee
authored andcommitted
Hi! I noticed that the changes made here: #295 have not made their way into the documentation! (#318)
* 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 * Updated CONTRIBUTING.md with npm run manual-test
1 parent 7a51432 commit 8d4abf4

File tree

3 files changed

+52
-19
lines changed

3 files changed

+52
-19
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

.github/PULL_REQUEST_TEMPLATE.md

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+

CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,13 @@ If you want to help develop this library, here are the steps to get started:
6262
6363
4. Develop!
6464
65-
Create a new folder called `/experiments` in the project's root folder. Create an `index.html` file inside `/experiments` and add the following:
65+
Run this command from the root of the project:
66+
67+
```bash
68+
npm run manual-test
69+
```
70+
71+
This creates a new folder called `/manual-test` in the project's root folder. Create an `index.html` file inside `/manual-test` and add the following:
6672

6773
```html
6874
<!DOCTYPE html>

0 commit comments

Comments
 (0)