docs(help commiting): main folder

This adds yarn to the main folder, and adds a commit modual BREAKING CHANGE: This may bug npm or yarn
YummyOreo · May 4, 2021 · e4b9015 · e4b9015 · YummyOreo · May 14, 2021
1 parent d15d348
commit e4b9015
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 85 deletions.
diff --git a/HOW_TO_COMMIT.md b/HOW_TO_COMMIT.md
@@ -0,0 +1,21 @@
+<h1 align="center">How To Commit</h1>
+
+- First:
+Add files 
+```console
+$ git add {Files/folders}
+```
+- Next
+Commit changed
+```console
+$ yarn coommit
+```
+This will prompt you with a commit message:
+- Select the type of change.
+- Type the scope/what you are tring to do
+- Type what files/folders you changed
+- Type what you did
+- y or n for whether there are any breaking changes
+- y or n for whether this change affects an open issue, if positive you will be prompted to enter the issue number.
+
+- Now you have your commit you may now push to your fork
diff --git a/README.md b/README.md
@@ -25,43 +25,22 @@ Only Ones that **Wont** go away (Not temporary)
 
 Chat House, is a app for creators. You can make different types of rooms for different purposes!
 
-## Notable features:
-
-- [ ] Make Rooms
-
-- [x] Room Types
-
 ## How to contribute:
 
-### Here is a list of things to do **before** helping:
-
-- Look at [issuse](https://github.com/OreoDivision/chat-house/issues) to find a issue that you want to work on
-  Or
-- Find something to add to
-
-#### Aslo make shoure what you want to work on is not in [Working On](WORKING_ON.md)
-
-### Then contact **OreoDivision** on discord @ OreoDivision#0001
-
-Go to discord and dm me something like this:
-
+- First find something to work on
+- Next get it working on you pc ([How to run](#how-to-run-the-app)])
+- Next fork the repo and work on your fixes/changes/additions
+- Now Read [How To Commit](HOW_TO_COMMIT.md)
+  - Using `yarn` so have that installed
+- Make a pr with a title and description
+  - To main, from your forked repo
+Title example:
 ```
-**I want to help with your chat app**
-I want to <add/fix>
-<Describe what you want to add>
+{User name} {pr index (number of pr you have done in the repo)}
 ```
 
-### Fork and make what you want:
-
-Make shoure you add comments and only change what you need to
-
-### Make A PR and your done!
-
-Open a pr with a description
-
 ## How to run the app
 
-There are 2 things to run, with the same command.
 
 ### First download the files
 
@@ -74,9 +53,12 @@ This will download the sorce for the chat app
 
 ### To run the api, [go here](https://github.com/OreoDivision/chat-house/blob/master/dinner/README.md)
 
-### Install Node JS
+### Install Node JS && Yarn
 
 To make the server and client work you need nodejs
 Go [here https://nodejs.org/en/](https://nodejs.org/en/)
 
+To have clean commands insall YARN
+[Yarn](https://classic.yarnpkg.com/en/docs/install)
+
 Now READ THE README.md in both the [lunch](lunch/README.md) and [breakfast](breakfast/README.md) folders
diff --git a/package.json b/package.json
@@ -6,7 +6,9 @@
   "dependencies": {
     "commitizen": "^4.2.3"
   },
-  "devDependencies": {},
+  "devDependencies": {
+    "cz-conventional-changelog": "3.3.0"
+  },
   "scripts": {
     "commit": "cz"
   },
@@ -16,5 +18,10 @@
   "bugs": {
     "url": "https://github.com/OreoDivision/chat-house/issues"
   },
-  "homepage": "https://github.com/OreoDivision/chat-house#readme"
+  "homepage": "https://github.com/OreoDivision/chat-house#readme",
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  }
 }
diff --git a/yarn.lock b/yarn.lock
@@ -316,11 +316,6 @@ cosmiconfig@^7.0.0:
     path-type "^4.0.0"
     yaml "^1.10.0"
 
-csstype@^3.0.8:
-  version "3.0.8"
-  resolved "https://registry.yarnpkg.com/csstype/-/csstype-3.0.8.tgz#d2266a792729fb227cd216fb572f43728e1ad340"
-  integrity sha512-jXKhWqXPmlUeoQnF/EhTtTl4C9SnrxSH/jZUih3jmO6lBKr99rP3/+FmrMj4EFpOXzMtXHAZkd3x0E6h6Fgflw==
-
 cz-conventional-changelog@3.2.0:
   version "3.2.0"
   resolved "https://registry.yarnpkg.com/cz-conventional-changelog/-/cz-conventional-changelog-3.2.0.tgz#6aef1f892d64113343d7e455529089ac9f20e477"
@@ -335,6 +330,20 @@ cz-conventional-changelog@3.2.0:
   optionalDependencies:
     "@commitlint/load" ">6.1.1"
 
+cz-conventional-changelog@3.3.0:
+  version "3.3.0"
+  resolved "https://registry.yarnpkg.com/cz-conventional-changelog/-/cz-conventional-changelog-3.3.0.tgz#9246947c90404149b3fe2cf7ee91acad3b7d22d2"
+  integrity sha512-U466fIzU5U22eES5lTNiNbZ+d8dfcHcssH4o7QsdWaCcRs/feIPCxKYSWkYBNs5mny7MvEfwpTLWjvbm94hecw==
+  dependencies:
+    chalk "^2.4.1"
+    commitizen "^4.0.3"
+    conventional-commit-types "^3.0.0"
+    lodash.map "^4.5.1"
+    longest "^2.0.1"
+    word-wrap "^1.0.3"
+  optionalDependencies:
+    "@commitlint/load" ">6.1.1"
+
 debug@^2.2.0, debug@^2.3.3:
   version "2.6.9"
   resolved "https://registry.yarnpkg.com/debug/-/debug-2.6.9.tgz#5d128515df134ff327e90a4c93f4e077a536341f"
@@ -800,7 +809,7 @@ isobject@^3.0.0, isobject@^3.0.1:
   resolved "https://registry.yarnpkg.com/isobject/-/isobject-3.0.1.tgz#4e431e92b11a9731636aa1f9c8d1ccbcfdab78df"
   integrity sha1-TkMekrEalzFjaqH5yNHMvP2reN8=
 
-"js-tokens@^3.0.0 || ^4.0.0", js-tokens@^4.0.0:
+js-tokens@^4.0.0:
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-4.0.0.tgz#19203fb59991df98e3a287050d4647cdeaf32499"
   integrity sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==
@@ -861,13 +870,6 @@ longest@^2.0.1:
   resolved "https://registry.yarnpkg.com/longest/-/longest-2.0.1.tgz#781e183296aa94f6d4d916dc335d0d17aefa23f8"
   integrity sha1-eB4YMpaqlPbU2RbcM10NF676I/g=
 
-loose-envify@^1.4.0:
-  version "1.4.0"
-  resolved "https://registry.yarnpkg.com/loose-envify/-/loose-envify-1.4.0.tgz#71ee51fa7be4caec1a63839f7e682d8132d30caf"
-  integrity sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==
-  dependencies:
-    js-tokens "^3.0.0 || ^4.0.0"
-
 map-cache@^0.2.2:
   version "0.2.2"
   resolved "https://registry.yarnpkg.com/map-cache/-/map-cache-0.2.2.tgz#c32abd0bd6525d9b051645bb4f26ac5dc98a0dbf"
@@ -956,11 +958,6 @@ nanomatch@^1.2.9:
     snapdragon "^0.8.1"
     to-regex "^3.0.1"
 
-object-assign@^4.1.1:
-  version "4.1.1"
-  resolved "https://registry.yarnpkg.com/object-assign/-/object-assign-4.1.1.tgz#2109adc7965887cfc05cbbd442cac8bfbb360863"
-  integrity sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM=
-
 object-copy@^0.1.0:
   version "0.1.0"
   resolved "https://registry.yarnpkg.com/object-copy/-/object-copy-0.1.0.tgz#7e7d858b781bd7c991a41ba975ed3812754e998c"
@@ -1045,40 +1042,6 @@ posix-character-classes@^0.1.0:
   resolved "https://registry.yarnpkg.com/posix-character-classes/-/posix-character-classes-0.1.1.tgz#01eac0fe3b5af71a2a6c02feabb8c1fef7e00eab"
   integrity sha1-AerA/jta9xoqbAL+q7jB/vfgDqs=
 
-prop-types@^15.7.2:
-  version "15.7.2"
-  resolved "https://registry.yarnpkg.com/prop-types/-/prop-types-15.7.2.tgz#52c41e75b8c87e72b9d9360e0206b99dcbffa6c5"
-  integrity sha512-8QQikdH7//R2vurIJSutZ1smHYTcLpRWEOlHnzcWHmBYrOGUysKwSsrC89BCiFj3CbrfJ/nXFdJepOVrY1GCHQ==
-  dependencies:
-    loose-envify "^1.4.0"
-    object-assign "^4.1.1"
-    react-is "^16.8.1"
-
-react-fast-compare@^3.1.1, react-fast-compare@^3.2.0:
-  version "3.2.0"
-  resolved "https://registry.yarnpkg.com/react-fast-compare/-/react-fast-compare-3.2.0.tgz#641a9da81b6a6320f270e89724fb45a0b39e43bb"
-  integrity sha512-rtGImPZ0YyLrscKI9xTpV8psd6I8VAtjKCzQDlzyDvqJA8XOW78TXYQwNRNd8g8JZnDu8q9Fu/1v4HPAVwVdHA==
-
-react-helmet@^6.1.0:
-  version "6.1.0"
-  resolved "https://registry.yarnpkg.com/react-helmet/-/react-helmet-6.1.0.tgz#a750d5165cb13cf213e44747502652e794468726"
-  integrity sha512-4uMzEY9nlDlgxr61NL3XbKRy1hEkXmKNXhjbAIOVw5vcFrsdYbH2FEwcNyWvWinl103nXgzYNlns9ca+8kFiWw==
-  dependencies:
-    object-assign "^4.1.1"
-    prop-types "^15.7.2"
-    react-fast-compare "^3.1.1"
-    react-side-effect "^2.1.0"
-
-react-is@^16.13.1, react-is@^16.8.1:
-  version "16.13.1"
-  resolved "https://registry.yarnpkg.com/react-is/-/react-is-16.13.1.tgz#789729a4dc36de2999dc156dd6c1d9c18cea56a4"
-  integrity sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==
-
-react-side-effect@^2.1.0, react-side-effect@^2.1.1:
-  version "2.1.1"
-  resolved "https://registry.yarnpkg.com/react-side-effect/-/react-side-effect-2.1.1.tgz#66c5701c3e7560ab4822a4ee2742dee215d72eb3"
-  integrity sha512-2FoTQzRNTncBVtnzxFOk2mCpcfxQpenBMbk5kSVBg5UcPqV9fRbgY2zhb7GTWWOlpFmAxhClBDlIq8Rsubz1yQ==
-
 regex-not@^1.0.0, regex-not@^1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/regex-not/-/regex-not-1.0.2.tgz#1f4ece27e00b0b65e0247a6810e6a85d83a5752c"