[SOA-13] Configure commitizen and add readme (#14)

* chore 🏗️ (config): add commitizen rules * chore 🏗️ (docs): add initial README
mariadriana-deemaze · Nov 7, 2024 · 3295ab8 · 3295ab8
1 parent 1a95208
commit 3295ab8
Show file tree

Hide file tree

Showing 3 changed files with 136 additions and 0 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023 Maria Adriana
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,41 @@
+# Social Adonis
+
+An exploratory hobby project that serves, to me, as an introduction to the combo of AdonisJS v6 + React via Inertia development conventions. The original product premise is to be a social media platform, with the intent of growing it organically, as time fits.
+
+### Project run
+
+1) Create a `.env` file, based of the `.env.example`, and customize the values as fitting for your local development environment.
+
+```bash
+$ cp .env.example .env
+```
+
+2) Install dependencies.
+
+```bash
+$ yarn
+```
+
+3) Run development.
+
+```bash
+$ yarn dev
+```
+
+### Implemented main features
+- Basic authentication;
+- User feed;
+- User posting CRUD;
+
+### Future roadmap
+Have planned a general gist on what I would like to shape it in the near future, publically visible in [board](https://github.com/users/mariadriana-deemaze/projects/2) here.
+
+### Commit
+The project is following the general guidance of commitizen rules, customizly adapted as per defined in the  `cz.json` file.
+To proceed with a project contribution, make sure to have globally enabled in your machine the [commitizen-cli](https://www.npmjs.com/package/commitizen).
+
+Then simply type in your terminal the following command, and follow along the configured prompts.
+
+```bash
+$ cz c
+```
diff --git a/cz.json b/cz.json
@@ -0,0 +1,86 @@
+{
+  "commitizen": {
+    "name": "cz_customize",
+    "tag_format": "$version",
+    "version_scheme": "semver",
+    "version_provider": "npm",
+    "customize": {
+      "message_template": "{{change_type}} {% if context %}({{context}}){% endif %}: {{ message }}",
+      "example": "feat(ui): add a shiny new feature",
+      "schema": "<type>(<context>): <body>",
+      "schema_pattern": "(feat|fix|styles|refactor|perf|test|chore):(\\s.*)",
+      "bump_pattern": "^(break|new|fix|hotfix)",
+      "bump_map": {
+        "break": "MAJOR",
+        "new": "MINOR",
+        "fix": "PATCH"
+      },
+      "change_type_order": [
+        "BREAKING CHANGE",
+        "feat",
+        "fix",
+        "refactor",
+        "perf",
+        "chore"
+      ],
+      "info_path": "cz_customize_info.txt",
+      "info": "This is customized info",
+      "commit_parser": "^(?P<change_type>feat|fix|styles|refactor|perf|test|chore(deps)|chore(config)):\\s(?P<message>.*)?",
+      "change_type_map": {
+        "feat": "Feat",
+        "fix": "Fix",
+        "refactor": "Refactor",
+        "perf": "Performance",
+        "test": "Test",
+        "chore": "Chore"
+      },
+      "questions": [
+        {
+          "type": "list",
+          "name": "change_type",
+          "choices": [
+            {
+              "value": "feat 🎸",
+              "name": "feat 🎸: added a new feature."
+            },
+            {
+              "value": "fix ✅",
+              "name": "fix ✅: added a bug fix."
+            },
+            {
+              "value": "styles 💅",
+              "name": "styles 💅: edited some UI styles or other general styling config."
+            },
+            {
+              "value": "refactor ✨",
+              "name": "refactor: refactored code that does not affect feature."
+            },
+            {
+              "value": "perf ⚡️",
+              "name": "perf ⚡️: made a performance inprovement."
+            },
+            {
+              "value": "test 🧪",
+              "name": "test 🧪: added tests."
+            },
+            {
+              "value": "chore 🏗️",
+              "name": "chore 🏗️: added or bumped dependencies."
+            }
+          ],
+          "message": "Select the type of change you are committing"
+        },
+        {
+          "type": "input",
+          "name": "context",
+          "message": "Do you want to add additional context?"
+        },
+        {
+          "type": "input",
+          "name": "message",
+          "message": "Body."
+        }
+      ]
+    }
+  }
+}