Merge branch 'main' into development

Author: amirfeqhi

.all-contributorsrc

@@ -1114,6 +1114,64 @@
       "contributions": [
         "doc"
       ]
+    },
+    {
+      "login": "tundiszasz",
+      "name": "Tündi Szász",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/19189730?v=4",
+      "profile": "http://www.tundiszasz.com",
+      "contributions": [
+        "design",
+        "ideas"
+      ]
+    },
+    {
+      "login": "hellonun",
+      "name": "hellonun",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/43077909?v=4",
+      "profile": "https://github.com/hellonun",
+      "contributions": [
+        "ideas",
+        "userTesting"
+      ]
+    },
+    {
+      "login": "pgrimaud",
+      "name": "Pierre Grimaud",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/1866496?v=4",
+      "profile": "https://github.com/pgrimaud",
+      "contributions": [
+        "doc",
+        "content"
+      ]
+    },
+    {
+      "login": "GregFrench",
+      "name": "Greg French",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/17938510?v=4",
+      "profile": "http://www.gregfrench.net/",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "dalequark",
+      "name": "Dale Markowitz",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/2328571?v=4",
+      "profile": "https://daleonai.com",
+      "contributions": [
+        "code",
+        "ideas"
+      ]
+    },
+    {
+      "login": "RaglandCodes",
+      "name": "Ragland Asir",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/39048764?v=4",
+      "profile": "http://raglandcodes.github.io",
+      "contributions": [
+        "doc"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.eslintignore

@@ -0,0 +1,4 @@
+dist
+dist_examples
+**/lib
+

.eslintrc.js

@@ -0,0 +1,47 @@
+const p5Globals = require("./p5Globals");
+const p5SoundGlobals = require("./p5SoundGlobals");
+
+module.exports = {
+  extends: ["airbnb-base", "prettier"],
+  globals: {
+    fetch: false,
+    document: true,
+  },
+  rules: {
+    "no-console": 0,
+  },
+  env: {
+    browser: true,
+    jasmine: true,
+  },
+  overrides: [
+    {
+      files: ["examples/**"],
+      globals: {
+        ml5: false,
+        p5: false,
+        ...p5Globals,
+        ...p5SoundGlobals,
+      },
+      rules: {
+        "no-use-before-define": [
+          "error",
+          {
+            functions: false,
+            classes: true,
+            variables: true,
+          },
+        ],
+        "no-unused-vars": ["error", { varsIgnorePattern: "^setup$|^draw$|^preload$" }],
+        "new-cap": 0,
+        "no-underscore-dangle": 0,
+      },
+    },
+    {
+      files: ["**/**_test.js"],
+      globals: {
+        ml5: false,
+      },
+    },
+  ],
+};

.eslintrc.json

@@ -20,7 +20,7 @@ I'm submitting a new issue. Please see the details below.
 
 
 ### → Step 3: Share an example of the issue 🦄
-> Here's some example code or a demonstration of my feature in this issue, separe GitHub repo, or in the https://editor.p5js.org or codepen/jsfiddle/Glitch/etc...
+> Here's some example code or a demonstration of my feature in this issue, separate GitHub repo, or in the https://editor.p5js.org or codepen/jsfiddle/Glitch/etc...
 
 
 

.github/ISSUE_TEMPLATE.md

@@ -9,12 +9,7 @@ I'm making a Pull Request(PR). Please see the details below.
 
 **A good PR 🌟**
 
-### → Step 1:  Which branch are you submitting to? 🌲
-> Development (for new features or updates), Release (for bug fixes), or ___________?
-
-
-
-### → Step 2: Describe your Pull Request 📝
+### → Step 1: Describe your Pull Request 📝
 > Fixing a Bug? Adding an Update? Submitting a New Feature? Does it introduce a breaking change?
 
 
@@ -23,15 +18,15 @@ I'm making a Pull Request(PR). Please see the details below.
 
 **A great PR 🌟🌟**
 
-### → Step 3: Share a Relevant Example 🦄
+### → Step 2: Share a Relevant Example 🦄
 > Here's some example code or a demonstration of my feature as a part of this pull request, a separate pull request, in the https://editor.p5js.org, or codepen/jsfiddle/etc...
 
 
 
 
 **The best PR 🌟🌟🌟**
 
-### → Step 4: Screenshots or Relevant Documentation 🖼
+### → Step 3: Screenshots or Relevant Documentation 🖼
 > Here's some helpful screenshots and/or documentation of the new feature 
 
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+name: reviewdog
+on: [pull_request]
+jobs:
+  eslint:
+    name: runner / eslint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: eslint
+        uses: reviewdog/action-eslint@v1
+        with:
+          github_token: ${{ secrets.github_token }}
+          reporter: github-pr-review # Change reporter.

.github/workflows/main.yml

@@ -1,7 +1,6 @@
 language: node_js
 node_js:
-  - "8"
-  - "10"
+  - "12"
 git:
   depth: 5
 script:

.travis.yml

@@ -41,7 +41,7 @@ We like these hashtags: #noCodeSnobs (because we value community over efficiency
 
 Our community is always looking for enthusiasts to help in all different ways.
 
--  **Develop**. [GitHub](https://github.com/ml5js/ml5-library) is the main place where code is collected, issues are documented, and discussions about code are had. Check out the [contributing documentation to get started](https://github.com/ml5js/ml5-library/blob/development/CONTRIBUTING.md) with developing the library.
+-  **Develop**. [GitHub](https://github.com/ml5js/ml5-library) is the main place where code is collected, issues are documented, and discussions about code are had. Check out the [contributing documentation to get started](https://github.com/ml5js/ml5-library/blob/main/CONTRIBUTING.md) with developing the library.
 -  **Document**. Everyone loves documentation. Help is needed porting examples, and adding documentation, and creating tutorials.
 -  **Teach**. Teach a workshop, a class, a friend, a collaborator! Tag [@ml5js on Twitter](https://twitter.com/ml5js?lang=en) and we will do our best to share what you're doing.
 -  **Create**. ml5.js is looking for designers, artists, coders, programmers to bring your creative and amazing work to show and inspire other people. Submit your work to [email protected].

CODE_OF_CONDUCT.md

@@ -3,11 +3,11 @@
 
 ![friendly machine learning for the web](assets/header.png)
 
-## The ml5 ecosystem (last updated: 22, March 2019)
+## The ml5 ecosystem (last updated: 24, May 2020)
 
 ml5.js is comprised a number of sister repositories which you can find at the [ml5 github organization - github.com/ml5js](https://github.com/ml5js). As a contributor of ml5 you should be aware of the other parallel repositories of the ml5 project.
 
-- **The 3 main repositories you'll likely be working with**:
+- **The 2 main repositories you'll likely be working with**:
   + [ml5-library]([https://github.com/ml5js](https://github.com/ml5js/ml5-library))
     * this is the main ml5js library. When building the library, all of the files in the `/src` directory get bundled into the `ml5.js` library. Releases to the ml5 library get sent to `npm` and are hosted at https://unpkg.com/ (e.g. `https://unpkg.com/[email protected]/dist/ml5.min.js`). When adding new features or updates to the ml5 library, you should also add an example in the `examples/` subdirectory of this repo to showcase how your new feature works. Usually examples are submitted in a simple p5.js sketch, but they can also be in vanilla javascript.
   + [ml5-website](https://github.com/ml5js/ml5-website)
@@ -37,8 +37,8 @@ Preamble: If you're interested in to contribute to the ml5 project, just know yo
 3. you make a comment on an existing issue or post your issue and indicate that you're curious to do your best to solve it 🔬
 4. you create a new branch on your `forked` copy of the ml5-library and call it something meaningful like `fix-detection-results`
 5. you jam on fixing the bug, commit your changes with meaningful commit messages, and push your changes to your bug fix branch (e.g. `fix-detection-results`)
-6. when ready, make a pull request to the `release` branch or `development` branch of ml5-library. Submit to the `release` branch if the bug you found was in the current ml5 release - the version of ml5 which is on npm. Submit to the `development` branch if the bug you found was in `development` branch of ml5-library.
-7. the ml5 dev team will review your changes and quite likely correspond with you on your changes. When all looks good, your changes will be merged in. 🎉
+6. when ready, make a pull request to the `main` branch of ml5-library. Prepend "[NEEDS RELEASE]" to the title if the bug you found was in the current ml5 release - the version of ml5 which is on npm. 
+7. the ml5 dev team will review your changes and quite likely correspond with you on your changes. When all looks good, a `ready for release` label will be added to your PR and your changes will be merged in and release with the next public update to the library. 🎉
 8. hi-fives 👏 and hugs 🤗
 
 ### For new features or feature additions/updates
@@ -48,7 +48,7 @@ Preamble: If you're interested in to contribute to the ml5 project, just know yo
 4. you create a new branch on your `forked` copy of the ml5-library and call it something meaningful like `new-generative-model-x`
 5. you jam on your new feature, commit your changes with meaningful commit messages, and push your changes to your new feature branch (e.g. `new-generative-model-x`)
 6. you should also add an example of your new feature to the `examples/` directory so that other people can learn how to use your new feature.
-7. when ready, make a pull request to the `development` branch of ml5-library. Submit to the `development` since your feature is part of the new frontier of the ml5-library. Important is step 7 below.
+7. when ready, make a pull request to the `main` branch of ml5-library.
 8. the ml5 dev team will review your changes and quite likely correspond with you on your changes. When all looks good, your changes will be merged in. 🎉
 9. hi-fives 👏 and hugs 🤗
 
@@ -168,21 +168,19 @@ NVM_HOMEBREW="/usr/local/opt/nvm/nvm.sh"
   npm run manual-test
   ```
 
-  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:
+  This creates a new folder called `/manual-test` in the project's root folder. The `/manual-test` folder contains an `index.html` file with the following content:
 
   ```html
   <!DOCTYPE html>
   <html>
   <head>
-    <title>Test</title>
+    <title>ml5.js manual test</title>
     <script src="http://localhost:8080/ml5.js"></script>
   </head>
   <body>
-
     <script>
-
+      // Your scripts would be written here
     </script>
-
   </body>
   </html>
   ```
@@ -254,6 +252,8 @@ This last one is case sensitive!
 
 ## Making Releases (For the ml5 core team)
 
+**NOTE: This section needs to be updated to align with the new `main` branch structure.**
+
 Work in progress - we are working on making a few scripts to make it easier to make releases and deployments. For now, to address the long-winded process noted in https://github.com/ml5js/ml5-library/issues/387, we are experimenting with some devOps scripts.
 
 In the instance you're ready to make a new release from `development` to `release`:
@@ -315,9 +315,9 @@ Go to Github and wait for tests to pass, then `squash and merge` the newly creat
 npm run publish:npm
 ```
 
-7. Enter your multi-factor auth when prompted where it says `OTP` (one time password): `your OTP code`
-8. Your new npm version should be released! 
-9. Lastly, go to Github and document that new release with `release notes`.
+10. Enter your multi-factor auth when prompted where it says `OTP` (one time password): `your OTP code`
+11. Your new npm version should be released! 
+12. Lastly, go to Github and document that new release with `release notes`.
 
 
 ## Additional Resources