Skip to content
This repository has been archived by the owner on Apr 6, 2020. It is now read-only.

Commit

Permalink
update gh templates (#211)
Browse files Browse the repository at this point in the history
  • Loading branch information
joeyklee authored Oct 10, 2019
1 parent 01b9dae commit 0120195
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 29 deletions.
63 changes: 48 additions & 15 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,57 @@
## → Description 📝
<!--------------------------------------------
🌈DEAR BELOVED ML5 COMMUNITY MEMBER. WELCOME. 🌈
---------------------------------------------->

A clear and concise description of what the issue is about. Let us know if you:
Dear ml5 community,

- found a bug 🐛
- want to suggest an update 💡
- have an idea for a new feature 🆕
I'm submitting a new issue. Please see the details below.



## Screenshots 🖼
(Any relevant screenshots, sketches, or helpful concept diagrams)
### Step 1: Describe the issue 📝
> Did you find a bug? Want to suggest an idea for a new example?

## → Helpful Information 🦄

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:

- **Web browser and version** (e.g. Firefox version 65, Chrome version 71.0)
- the **ml5-examples branch** you're using - this is important since the examples may differ between `release` and `development`
- **Operating System** (e.g. MacOS, Windows, Ubuntu)
- Steps to reproduce the issue
- ml5 version you're using
- Links to example code in the [p5 web editor](https://editor.p5js.org) or other online shareable code editor
### → Step 2: Screenshots or Relevant Documentation 🖼
> Here's some helpful screenshots and/or documentation of the new feature


### → Step 3: Share an example of the issue 🦄
> Here's some example code or a demonstration of the issue in https://github.com/ml5js/ml5-examples OR in the https://editor.p5js.org or codepen/jsfiddle/etc...





**Other relevant information, if applicable**

### → Describe your setup 🦄
> Here's some helpful information about my setup...
- **Web browser & version**:
- **Operating System**:
- **ml5 version you're using**:
- **Any additional notes**



<!--------------------------------------------
🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈
DEAR BELOVED ML5 COMMUNITY MEMBER. WELCOME.
BEFORE SUBMITTING AN ISSUE PLEASE MAKE
SURE TO SUBMIT THE RELEVANT INFORMATION
TO THE SECTIONS LISTED BELOW.
HELP US HELP YOU BY PROVIDING ALL THE HELPFUL
INFORMATION THAT WILL ALLOW THE ML5 COMMUNITY
TO UNDERSTAND WHAT YOUR ISSUE SUBMISSION IS ABOUT.
WE WILL PRIORITIZE WELL DOCUMENTED ISSUES.
THANK YOU! MERCI! ABRIGADO! GRACIAS! DANKE!
🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈
---------------------------------------------->

56 changes: 42 additions & 14 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,55 @@
<!-- MANY MANY THANKS FOR YOUR CONTRIBUTION. ML5 ❤️S YOU! -->
## → Submit changes to the relevant branch 🌲
<!--------------------------------------------
🌈DEAR BELOVED ML5 COMMUNITY MEMBER. WELCOME. 🌈
---------------------------------------------->

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.
Dear ml5 community,

- for pull requests related to **new features** 🆕 make sure to use the **development** branch
- for pull requests related to bug 🐛fixes of the existing stable release, make sure your pull request goes to the **release** branch.
I'm making a Pull Request(PR). Please see the details below.


## → Description 📝
**A good PR 🌟**

A clear and concise description of what the pull request is about. Let us know if you are:
### → Step 1: Which branch are you submitting to? 🌲
> Development (for new features or updates), Release (for bug fixes), or ___________?
- fixing a bug 🐛
- adding an update 🛠
- submitting a new feature 🆕

## → Screenshots 🖼
(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!)

### → Step 2: Describe your Pull Request 📝
> Fixing a Bug? Adding an Update? Submitting a New Example? Does it introduce a breaking change?
## → Relevant documentation 🌴

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! 🙏



**A great PR 🌟🌟**

### → Step 3: Share a Relevant Example 🦄
> Here's some example code or a link to another PR in https://github.com/ml5js/ml5-examples OR in the https://editor.p5js.org or codepen/jsfiddle/etc...



**The best PR 🌟🌟🌟**

### → Step 4: Screenshots or Relevant Documentation 🖼
> Here's some helpful screenshots and/or documentation of the new feature



<!--
BEFORE SUBMITTING YOUR PULL REQUEST PLEASE MAKE
SURE TO SUBMIT THE RELEVANT INFORMATION
TO THE SECTIONS LISTED BELOW.
HELP US HELP YOU BY PROVIDING ALL THE HELPFUL
INFORMATION THAT WILL ALLOW THE ML5 COMMUNITY
TO UNDERSTAND WHAT YOUR PR IS ABOUT.
WE WILL PRIORITIZE WELL A DOCUMENTED PR.
THANK YOU! MERCI! ABRIGADO! GRACIAS! DANKE!
-->




0 comments on commit 0120195

Please sign in to comment.