From 8edf4253a090b2c550a29b94b131086defbb8b02 Mon Sep 17 00:00:00 2001 From: "(Holloway) Chew, Kean Ho" Date: Mon, 4 Mar 2024 13:16:48 +0800 Subject: [PATCH] root: upgraded repository matching the latest standards The current repository is not matching our ZORALab workflow and GitHub systems. Hence, let's upgrade it. This patch upgrades the repository to match the latest standards for ZORALab and GitHub in root directory. Co-authored-by: Galyna, Cory Co-authored-by: (Holloway) Chew, Kean Ho Signed-off-by: (Holloway) Chew, Kean Ho --- .github/ISSUE_TEMPLATE/Artwork.yml | 45 ++++++ .github/ISSUE_TEMPLATE/Bug_n_Glitch.yml | 53 +++++++ .github/ISSUE_TEMPLATE/Communities.yml | 43 ++++++ .github/ISSUE_TEMPLATE/Documentation.yml | 51 +++++++ .github/ISSUE_TEMPLATE/Enhancement.yml | 44 ++++++ .github/ISSUE_TEMPLATE/Infrastructure.yml | 43 ++++++ .github/ISSUE_TEMPLATE/New.yml | 43 ++++++ .github/ISSUE_TEMPLATE/Payment.yml | 43 ++++++ .github/ISSUE_TEMPLATE/Question.yml | 28 ++++ .github/ISSUE_TEMPLATE/Sponsorship.yml | 43 ++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .../pull_request_template.md | 135 ++++++++++++++++++ .github/images/sponsor_en_100x30.svg | 15 ++ .github/images/sponsor_en_210x50.svg | 11 ++ .github/images/sponsor_fr_100x30.svg | 16 +++ .github/images/sponsor_fr_210x50.svg | 13 ++ .github/images/sponsor_ms-my_100x30.svg | 13 ++ .github/images/sponsor_ms-my_210x50.svg | 11 ++ .github/images/sponsor_zh-hans_100x30.svg | 15 ++ .github/images/sponsor_zh-hans_210x50.svg | 13 ++ .github/workflows/git-push.yml | 111 ++++++++++++++ .gitignore | 110 ++++++++++++-- .gitlab/issue_templates/Bug.md | 41 ++++++ .../issue_templates/Documentation Problem.md | 41 ++++++ .../issue_templates/Feature Enhancement.md | 37 +++++ .../issue_templates/New Feature Request.md | 37 +++++ .gitlab/issue_templates/Question.md | 38 +++++ .gitlab/merge_request_templates/default.md | 129 +++++++++++++++++ CODE_OF_CONDUCT.md | 132 +++++++++++++++++ CONTRIBUTING.md | 17 +-- SECURITY.md | 14 ++ 31 files changed, 1363 insertions(+), 23 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/Artwork.yml create mode 100644 .github/ISSUE_TEMPLATE/Bug_n_Glitch.yml create mode 100644 .github/ISSUE_TEMPLATE/Communities.yml create mode 100644 .github/ISSUE_TEMPLATE/Documentation.yml create mode 100644 .github/ISSUE_TEMPLATE/Enhancement.yml create mode 100644 .github/ISSUE_TEMPLATE/Infrastructure.yml create mode 100644 .github/ISSUE_TEMPLATE/New.yml create mode 100644 .github/ISSUE_TEMPLATE/Payment.yml create mode 100644 .github/ISSUE_TEMPLATE/Question.yml create mode 100644 .github/ISSUE_TEMPLATE/Sponsorship.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md create mode 100644 .github/images/sponsor_en_100x30.svg create mode 100644 .github/images/sponsor_en_210x50.svg create mode 100644 .github/images/sponsor_fr_100x30.svg create mode 100644 .github/images/sponsor_fr_210x50.svg create mode 100644 .github/images/sponsor_ms-my_100x30.svg create mode 100644 .github/images/sponsor_ms-my_210x50.svg create mode 100644 .github/images/sponsor_zh-hans_100x30.svg create mode 100644 .github/images/sponsor_zh-hans_210x50.svg create mode 100644 .github/workflows/git-push.yml create mode 100644 .gitlab/issue_templates/Bug.md create mode 100644 .gitlab/issue_templates/Documentation Problem.md create mode 100644 .gitlab/issue_templates/Feature Enhancement.md create mode 100644 .gitlab/issue_templates/New Feature Request.md create mode 100644 .gitlab/issue_templates/Question.md create mode 100644 .gitlab/merge_request_templates/default.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 SECURITY.md diff --git a/.github/ISSUE_TEMPLATE/Artwork.yml b/.github/ISSUE_TEMPLATE/Artwork.yml new file mode 100644 index 0000000..ebacae3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Artwork.yml @@ -0,0 +1,45 @@ +name: "Art Directive" +description: "To report a case related to artwork and art direction." +labels: [ "Artwork", "Discussion" ] +body: + - type: textarea + id: description + attributes: + label: Description + description: > + Please provide a short description of what you are looking forward to + have. + placeholder: "E.g: I want a soup to be presented as smiling kitty cat face." + validations: + required: true + - type: textarea + id: expectation + attributes: + label: Expected Behavior + description: > + Please specify the expected behavior below of your request feature. You + may upload your associated artwork presentations here. + placeholder: "E.g: something like this one (attached sketch file)." + validations: + required: true + - type: textarea + id: current + attributes: + label: Current Behavior + description: > + Please specify the any current behavior. You may upload the current + artwork presentation here. + placeholder: "E.g: no art. A bit boring." + validations: + required: true + - type: textarea + id: attachments + attributes: + label: Associated Data Files + description: > + Please drag and drop all other necessary data files (e.g. screenshot, + logs, etc) into the box below. Each successful upload shall render an + URL link on its own. + placeholder: "Please drag and drop it here." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/Bug_n_Glitch.yml b/.github/ISSUE_TEMPLATE/Bug_n_Glitch.yml new file mode 100644 index 0000000..55a7ba2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug_n_Glitch.yml @@ -0,0 +1,53 @@ +name: "Bug & Glitch" +description: "To report a bug or a glitch regarding about the project." +labels: [ "Bug", "Discussion" ] +body: + - type: textarea + id: description + attributes: + label: Description + description: > + Please provide a short description of what you had encountered. + placeholder: "E.g: Ginseng and white raddish together in a soup, are you crazy?!" + validations: + required: true + - type: textarea + id: expectation + attributes: + label: Expected Behavior + description: > + Please specify the expected behavior below. + placeholder: "E.g: split them into 2 different soup dishes and recipes." + validations: + required: true + - type: textarea + id: current + attributes: + label: Current Behavior + description: > + Please specify the current behavior below. + placeholder: "E.g: 1 recipe with those 2 are gonna be wasteful." + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Steps to Reproduce [COMPULSORY] + description: > + Please specify all the steps required to re-produce to the problem. If + the team are not able to reproduce the problem even a slighest symptom + of it, then this ticket shall be closed as "Will Not Implement". + placeholder: "E.g:\n1. Refer the menu. A.\n2. Order item 'Gala Soup'.\n3. Observe." + validations: + required: true + - type: textarea + id: attachments + attributes: + label: Associated Data Files + description: > + Please drag and drop all the necessary data files (e.g. screenshot, + logs, etc) into the box below. Each successful uploads shall render an + URL link on its own. + placeholder: "Please drag and drop it here." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/Communities.yml b/.github/ISSUE_TEMPLATE/Communities.yml new file mode 100644 index 0000000..4bfc1dc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Communities.yml @@ -0,0 +1,43 @@ +name: "Communities" +description: "To report a case solely related to the project's communities." +labels: [ "Communities", "Discussion" ] +body: + - type: textarea + id: description + attributes: + label: Description + description: > + Please provide a short description of what you are looking forward to + have. + placeholder: "E.g: I want a rave man!" + validations: + required: true + - type: textarea + id: expectation + attributes: + label: Expected Behavior + description: > + Please specify the expected behavior below of your request feature. + placeholder: "E.g: good food, good drink; lacks the party atmosphere." + validations: + required: true + - type: textarea + id: current + attributes: + label: Current Behavior + description: > + Please specify the any current behavior (e.g. workarounds). + placeholder: "E.g: no workaround. Need to spice up a little." + validations: + required: true + - type: textarea + id: attachments + attributes: + label: Associated Data Files + description: > + Please drag and drop all the necessary data files (e.g. screenshot, + logs, etc) into the box below. Each successful upload shall render an + URL link on its own. + placeholder: "Please drag and drop it here." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/Documentation.yml b/.github/ISSUE_TEMPLATE/Documentation.yml new file mode 100644 index 0000000..823bafd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Documentation.yml @@ -0,0 +1,51 @@ +name: "Documentations" +description: "To report something about the project's documentation." +labels: [ "Documentation", "Discussion" ] +body: + - type: textarea + id: description + attributes: + label: Description + description: > + Please provide a short description of what you had encountered. + placeholder: "E.g: I saw a typo at Section 2.1.3 - 'glicth' should be 'glitch'." + validations: + required: true + - type: input + id: url + attributes: + label: Page URL Address + description: > + Please provide the documentation link if applicable. + placeholder: "E.g: https://www.github.com/hollowaykeanho" + validations: + required: false + - type: textarea + id: expectation + attributes: + label: Expected Presentation + description: > + Please specify the expected presentation below. + placeholder: "E.g: ... report a glitch at ..." + validations: + required: true + - type: textarea + id: current + attributes: + label: Current Behavior + description: > + Please specify the current presentation below. + placeholder: "E.g: Section 2.1.3 -> ... report a glicth at ..." + validations: + required: true + - type: textarea + id: attachments + attributes: + label: Associated Data Files + description: > + Please drag and drop all the necessary data files (e.g. screenshot, + logs, etc) into the box below. Each successful uploads shall render an + URL link on its own. + placeholder: "Please drag and drop it here." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/Enhancement.yml b/.github/ISSUE_TEMPLATE/Enhancement.yml new file mode 100644 index 0000000..da55f19 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Enhancement.yml @@ -0,0 +1,44 @@ +name: "Enhance A Feature" +description: "To request a feature enhancement for the project." +labels: [ "Enhancement", "Discussion" ] +body: + - type: textarea + id: description + attributes: + label: Description + description: > + Please provide a short description of what you're looking forward to + enhance or remove. Please include the story behind the idea to better + visualize your case. + placeholder: "E.g: 15cm noodle instead of 5cm - slurp up too quickly." + validations: + required: true + - type: textarea + id: expectation + attributes: + label: Expected Behavior + description: > + Please specify the expected behavior below. + placeholder: "E.g: Noodle is at least 15cm longer." + validations: + required: true + - type: textarea + id: current + attributes: + label: Current Behavior + description: > + Please specify the current behavior below. + placeholder: "E.g: Noodle is 5cm long and slupped up in 2 seconds. Not enjoyable." + validations: + required: true + - type: textarea + id: attachments + attributes: + label: Associated Data Files + description: > + Please drag and drop all the necessary data files (e.g. screenshot, + logs, etc) into the box below. Each successful uploads shall render an + URL link on its own. + placeholder: "Please drag and drop it here." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/Infrastructure.yml b/.github/ISSUE_TEMPLATE/Infrastructure.yml new file mode 100644 index 0000000..60428b9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Infrastructure.yml @@ -0,0 +1,43 @@ +name: "Infrastructure (CI, Work System, etc)" +description: "To report a case solely related to infrastructure." +labels: [ "Infrastructure", "Discussion" ] +body: + - type: textarea + id: description + attributes: + label: Description + description: > + Please provide a short description of what you are looking forward to + have. + placeholder: "E.g: I want an ambient light at my noodle isle!" + validations: + required: true + - type: textarea + id: expectation + attributes: + label: Expected Behavior + description: > + Please specify the expected behavior below of your request feature. + placeholder: "E.g: LED light (lime is great!)." + validations: + required: true + - type: textarea + id: current + attributes: + label: Current Behavior + description: > + Please specify the any current behavior (e.g. workarounds). + placeholder: "E.g: Candles... are you serious?" + validations: + required: true + - type: textarea + id: attachments + attributes: + label: Associated Data Files + description: > + Please drag and drop all the necessary data files (e.g. screenshot, + logs, etc) into the box below. Each successful upload shall render an + URL link on its own. + placeholder: "Please drag and drop it here." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/New.yml b/.github/ISSUE_TEMPLATE/New.yml new file mode 100644 index 0000000..7c96458 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/New.yml @@ -0,0 +1,43 @@ +name: "New Feature Request" +description: "To request a new feature for the project." +labels: [ "New Feature", "Discussion" ] +body: + - type: textarea + id: description + attributes: + label: Description + description: > + Please provide a short description of what you are looking forward to + have. + placeholder: "E.g: I want a soup as a side dish!" + validations: + required: true + - type: textarea + id: expectation + attributes: + label: Expected Behavior + description: > + Please specify the expected behavior below of your request feature. + placeholder: "E.g: the soup must have tonkotsu, shio, shoyu, and miso." + validations: + required: true + - type: textarea + id: current + attributes: + label: Current Behavior + description: > + Please specify the any current behavior (e.g. workarounds). + placeholder: "E.g: no workaround." + validations: + required: true + - type: textarea + id: attachments + attributes: + label: Associated Data Files + description: > + Please drag and drop all the necessary data files (e.g. screenshot, + logs, etc) into the box below. Each successful upload shall render an + URL link on its own. + placeholder: "Please drag and drop it here." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/Payment.yml b/.github/ISSUE_TEMPLATE/Payment.yml new file mode 100644 index 0000000..9a758bd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Payment.yml @@ -0,0 +1,43 @@ +name: "Payment" +description: "To report a case related to a payment transaction for the project." +labels: [ "Payment", "Discussion" ] +body: + - type: textarea + id: description + attributes: + label: Description + description: > + Please provide a short description of what you are looking forward to + have. + placeholder: "E.g: You forgotten to discount my noodle meal. Please amend." + validations: + required: true + - type: textarea + id: expectation + attributes: + label: Expected Behavior + description: > + Please specify the expected behavior below of your request feature. + placeholder: "E.g: Should be USD8.00." + validations: + required: true + - type: textarea + id: current + attributes: + label: Current Behavior + description: > + Please specify the any current behavior (e.g. workarounds). + placeholder: "E.g: Being charged USD10.00." + validations: + required: true + - type: textarea + id: attachments + attributes: + label: Associated Data Files + description: > + Please drag and drop all the necessary data files (e.g. screenshot, + logs, etc) into the box below. Each successful upload shall render an + URL link on its own. + placeholder: "Please drag and drop it here." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/Question.yml b/.github/ISSUE_TEMPLATE/Question.yml new file mode 100644 index 0000000..3586d04 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Question.yml @@ -0,0 +1,28 @@ +name: "Question" +description: "To query something about the project." +labels: [ "Question", "Discussion" ] +body: + - type: textarea + id: description + attributes: + label: Description + description: > + Please provide a short description of your query. + placeholder: "E.g: what's that delicious meat in the meal?" + validations: + required: true + - type: textarea + id: current + attributes: + label: Current Researched Artifacts [COMPULSORY] + description: > + Please list out all your research artifacts that you did (e.g. link, + blog post, documentations, and etc) for us to gauge your context and + current efforts. You can drag and drop all the necessary data files + (e.g. screenshot, logs, etc) into the box as well. Each successful + upload shall render an URL link on its own. **NOTE: We may not reply + you and will close the ticket with perjuidice if this section remains + empty or unconvincing**. + placeholder: "E.g: I did a lab report as attached. They can't tell." + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/Sponsorship.yml b/.github/ISSUE_TEMPLATE/Sponsorship.yml new file mode 100644 index 0000000..ae626fe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Sponsorship.yml @@ -0,0 +1,43 @@ +name: "Sponsorship" +description: "To report a case solely related to the project's sponsorship." +labels: [ "Sponsorship", "Discussion" ] +body: + - type: textarea + id: description + attributes: + label: Description + description: > + Please provide a short description of what you are looking forward to + have. + placeholder: "E.g: I want to sponsor your brand!" + validations: + required: true + - type: textarea + id: expectation + attributes: + label: Expected Behavior + description: > + Please specify the expected behavior below of your request feature. + placeholder: "E.g: Let's talk business, like ads, materials, etc." + validations: + required: true + - type: textarea + id: current + attributes: + label: Current Behavior + description: > + Please specify the any current behavior (e.g. workarounds). + placeholder: "E.g: I see potential future in your business." + validations: + required: true + - type: textarea + id: attachments + attributes: + label: Associated Data Files + description: > + Please drag and drop all the necessary data files (e.g. screenshot, + logs, etc) into the box below. Each successful upload shall render an + URL link on its own. + placeholder: "Please drag and drop it here." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..984a426 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,135 @@ +# Prologue + +**We DO NOT ACCEPT ANY PULL/MERGE REQUEST FOR THIS REPOSITORY**. + +The right procedure for contributing back via these platform services ARE: + +1. **Generate and submit your patches into your corresponding issue ticket**; +2. Feel free to ask any technical questions about patch generations; +3. Once the basic are cleared, We will `git am` (apply) the submitted patch. If + it works, it will then be treated as accepted. + + + + +# Why? + +We want to: + +1. **Retaining all changes and information inside git log ONLY**; and +2. **Avoiding complete vendor locked-in**; and +3. **Continue to facilitate offline and disconnected native git services** + +Like it or not, any GVCS (e.g. GitHub/GitLab/Gitea) are supplying vendors and +they can introduce drastic business changes overtime to the point where we can +terminate their supplying services. + +Hence, to prevent vendor lock-in problem, we are: + +1. use the native `git` functionalities to maintain the source codes; WHILE +2. only use the GVCS to facilitate mirror-ed hosting and communications only. + +In any cases, we do not mind losing the forum but we are very agitated if the +repository maintenance works are unnecessarily being threatened by a known and +identified supply-chain threat. + + + + +# What is Required in Your Commit Messages + +**Write the whole ESSAY of the issue ticket you are working on**. Remember the +goal is to capture your commitment from problem to why we should apply your +patch. + +A format template is as follows: + +``` +: # **REQUIRED**: max 65 characters + # **REQUIRED**: LEAVE THIS EMPTY new LINE +[1st Para: explain the issue problem] # **REQUIRED**: explain the problem + # presented by the issue ticket. It's a + # paragraph, so use as long as you want. + # + # line should wrap at MAX 80 characters. + # + # If can, include the submitted + # data problems (e.g. log data). + # + # Mentions about the severity of the + # problem (e.g. workaround? critical?). + # See applied labels. + # + # **REQUIRED**: LEAVE THIS EMPTY new LINE +[2nd Para: explain this patch's work] # Only explains what this patch does for + # its approach to solve the problem + # you mentioned above. It's a + # paragraph, so use as long as you want. + # + # line should wrap at MAX 80 characters. + # + # **REQUIRED**: leave THIS empty new line +Signed-off-by: [NAME] <[EMAIL]> # **REQUIRED**: Your git signature here. +``` + +You can refer to the `git log` for inspirations or just ask us in the issue +ticket you're working on. + +Note that: + +1. You **DO NOT NEED** to explain how the codes work or what are the +files involved. The patch already presented the data. +2. If your effort involves some kind of algorithm explaination, make sure to +include its documentations and mentions where to find them so that your +reviewers know where to digest them. + + + + +## GPG Signature for Commit Signature + +**Optional but highly recommended** since we are doing manual code-review and +automated CI testing internally on our side with our own automation tools. + +If you're signing, please provide your public key source so that we can verify +you internally in the future. + + + + +# To Generate Patches + +To create your patches, please use any of the following `git` command: + +```bash +$ git format-patch .. +``` + +> Example: +> +> `$ git format-patch fed1235..ab32123` +> `$ git format-patch HEAD~3..HEAD` + +This is recommended since: + +1. The smaller, single-purpose of the patches, the easier to review and accept. + +**OR Alternatively** + +```bash +$ git format-patch ^.. --stdout > my.patch +``` + +> Example: +> +> `$ git format-patch fed1235^..ab32123 --stdout > my.patch` + + + + +# Epilogue + +That's all from us. Your pull request **SHALL BE REJECTED WITH PERJUDICE** if +you choose to ignore this message. + +Thank you for your cooperation. diff --git a/.github/images/sponsor_en_100x30.svg b/.github/images/sponsor_en_100x30.svg new file mode 100644 index 0000000..2ca51a8 --- /dev/null +++ b/.github/images/sponsor_en_100x30.svg @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/.github/images/sponsor_en_210x50.svg b/.github/images/sponsor_en_210x50.svg new file mode 100644 index 0000000..a959ae0 --- /dev/null +++ b/.github/images/sponsor_en_210x50.svg @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/.github/images/sponsor_fr_100x30.svg b/.github/images/sponsor_fr_100x30.svg new file mode 100644 index 0000000..bbff257 --- /dev/null +++ b/.github/images/sponsor_fr_100x30.svg @@ -0,0 +1,16 @@ + + + + + + + + + + + + + + + + diff --git a/.github/images/sponsor_fr_210x50.svg b/.github/images/sponsor_fr_210x50.svg new file mode 100644 index 0000000..38f894b --- /dev/null +++ b/.github/images/sponsor_fr_210x50.svg @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/.github/images/sponsor_ms-my_100x30.svg b/.github/images/sponsor_ms-my_100x30.svg new file mode 100644 index 0000000..10f0037 --- /dev/null +++ b/.github/images/sponsor_ms-my_100x30.svg @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/.github/images/sponsor_ms-my_210x50.svg b/.github/images/sponsor_ms-my_210x50.svg new file mode 100644 index 0000000..76595a7 --- /dev/null +++ b/.github/images/sponsor_ms-my_210x50.svg @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/.github/images/sponsor_zh-hans_100x30.svg b/.github/images/sponsor_zh-hans_100x30.svg new file mode 100644 index 0000000..a957d0f --- /dev/null +++ b/.github/images/sponsor_zh-hans_100x30.svg @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/.github/images/sponsor_zh-hans_210x50.svg b/.github/images/sponsor_zh-hans_210x50.svg new file mode 100644 index 0000000..168fe12 --- /dev/null +++ b/.github/images/sponsor_zh-hans_210x50.svg @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/.github/workflows/git-push.yml b/.github/workflows/git-push.yml new file mode 100644 index 0000000..fa3380e --- /dev/null +++ b/.github/workflows/git-push.yml @@ -0,0 +1,111 @@ +name: on Git Push +run-name: CI Run upon Git Push. +on: + push: + branches: + - main + - stable + - next + - testing + - staging + - edge + - experimental +jobs: + develop_on: + runs-on: ${{ matrix.os }} + strategy: + fail-fast: false + matrix: + os: [ubuntu-latest, macos-latest, windows-latest] + env: + TERM: xterm-256color + CONTAINER_USERNAME: ${{ secrets.CONTAINER_USERNAME }} + CONTAINER_PASSWORD: ${{ secrets.CONTAINER_PASSWORD }} + TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }} + TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }} + PROJECT_SIMULATE_RELEASE_REPO: true + steps: + - name: Checking out designated commit - GITHUB ACTIONS + id: git_check_out + uses: actions/checkout@v4 + - name: Initialize - GITHUB ACTIONS + id: git_initialize + run: | + git config --global user.email "github.actions.runner@github.com" + git config --global user.name "Github Action Automated Runner" + - name: Execute repo's AutomataCI - PURGE + id: native_ci_purge + run: | + ./automataCI/ci.sh.ps1 purge + - name: Execute repo's AutomataCI - CLEAN + id: native_ci_clean + run: | + ./automataCI/ci.sh.ps1 clean + - name: Execute repo's AutomataCI - ENVIRONMENT + id: native_ci_env + run: | + ./automataCI/ci.sh.ps1 env + - name: Execute repo's AutomataCI - SETUP + id: native_ci_setup + run: | + ./automataCI/ci.sh.ps1 setup + - name: Execute repo's AutomataCI - PREPARE + id: native_ci_prepare + run: | + ./automataCI/ci.sh.ps1 prepare + - name: Execute repo's AutomataCI - START + id: native_ci_start + run: | + ./automataCI/ci.sh.ps1 start + - name: Execute repo's AutomataCI - TEST + id: native_ci_test + run: | + ./automataCI/ci.sh.ps1 test + - name: Execute repo's AutomataCI - MATERIALIZE + id: native_ci_materialize + run: | + ./automataCI/ci.sh.ps1 materialize + - name: Execute repo's AutomataCI - BUILD + id: native_ci_build + run: | + ./automataCI/ci.sh.ps1 build + - name: Execute repo's AutomataCI - NOTARIZE + id: native_ci_notarize + run: | + ./automataCI/ci.sh.ps1 notarize + - name: Execute repo's AutomataCI - PACKAGE + id: native_ci_package + run: | + ./automataCI/ci.sh.ps1 package + - name: Execute repo's AutomataCI - RELEASE + id: native_ci_release + run: | + ./automataCI/ci.sh.ps1 release + - name: Execute repo's AutomataCI - STOP + id: native_ci_stop + run: | + ./automataCI/ci.sh.ps1 stop + - name: Execute repo's AutomataCI - DEPLOY + id: native_ci_deploy + run: | + ./automataCI/ci.sh.ps1 deploy + - name: Archive Payloads Artifacts + if: always() + uses: actions/upload-artifact@v3 + with: + name: build_${{ matrix.os }} + path: | + build/ + log/ + pkg/ + public/ + - name: Archive Workspace Artifacts + if: always() + uses: actions/upload-artifact@v3 + with: + name: workspace_${{ matrix.os }} + path: | + bin/ + lib/ + tmp/ + releases/ diff --git a/.gitignore b/.gitignore index 79a79ac..0d278db 100644 --- a/.gitignore +++ b/.gitignore @@ -1,21 +1,78 @@ ##################### # User defined ##################### -.uuid - ##################### # Standard FHS ##################### -bin -tmp -release -public +vendor/ +output/ +/releases/ +!/*/releases/ + +##################### +# ZORALab's Monteur +##################### +/.monteurFS/ +/.configs/montuer/secrets/ +.bin/ + +##################### +# AutomataCI +##################### +/SECRETS.toml +/bin +/tools +/tmp +/log +/build +/pkg +/releases +/resources/changelog/*/.* + +##################### +# Angular +##################### +/out-tsc +/bazel-out +cache/ +coverage/ +dist/ +.sass-cache/ +connect.lock +libpeerconnection.log +testem.log +typings + +##################### +# LibreOffice +##################### +.~lock* + +##################### +# Python +##################### +venv/ +__pycache__ +.coverage + +##################### +# Rust +##################### +target/ +*.profraw ##################### # Hugo ##################### -_gen +themes/ +public/ +.hugo_build.lock + +##################### +# LetsEncrypt +##################### +certbot.log ##################### # Android Studio @@ -23,7 +80,7 @@ _gen /build ##################### -# vim specifics +# vim ##################### 4913 *.swp @@ -34,14 +91,48 @@ _gen *.d !*.d/ *.o +*.a +*.dll +*.exe *.elf *.hex *.bin ##################### -# Mac specifics +# Node +##################### +node_modules +npm-debug.log +yarn-error.log + +##################### +# Databases +##################### +*.db + +##################### +# SQLite +##################### +*.sqlite3 +*.sqlite +*.sqlite-journal +*.db-journal + +##################### +# GitHub +##################### +gh-pages/ + +##################### +# Logs +##################### +*.log + +##################### +# MacOS specifics ##################### .DS_Store +Thumbs.db ##################### # AWS CLI credential blobs @@ -91,6 +182,7 @@ id_ecdsa ##################### *.pem *.key +*.crt ##################### # Any file ending with _history or .history extension diff --git a/.gitlab/issue_templates/Bug.md b/.gitlab/issue_templates/Bug.md new file mode 100644 index 0000000..4dfdb81 --- /dev/null +++ b/.gitlab/issue_templates/Bug.md @@ -0,0 +1,41 @@ +[comment]: # (GitLab Internal Operation Headers) +/label ~"Bug" ~"Discussion" +[comment]: # (GitLab Internal Operation Headers) + +# Description +``` +Please provide a short description of what you have encountered below. +``` + + + + +# Expected Behavior +``` +Please specify the expected behavior of your usage below. +``` + + + + +# Current Behavior +``` +Please specify the current behavior of software below. +``` + + + + +# Steps to Reproduce (COMPULSORY) +``` +Please specify all the steps required to re-produce the problem. +``` + + + + +# Attachment +``` +Please drag and drop the necessary data files (e.g. screenshot, logs, etc) +below. +``` diff --git a/.gitlab/issue_templates/Documentation Problem.md b/.gitlab/issue_templates/Documentation Problem.md new file mode 100644 index 0000000..4722ba3 --- /dev/null +++ b/.gitlab/issue_templates/Documentation Problem.md @@ -0,0 +1,41 @@ +[comment]: # (GitLab Internal Operation Headers) +/label ~"Documentation" ~"Discussion" +[comment]: # (GitLab Internal Operation Headers) + +# Description +``` +Please provide a short description of what you have encountered below. +``` + + + + +# Link +``` +Please provide the documentation link(s) below. +``` + + + + +# Expected Presentation +``` +Please specify the expected presentation of the documentation. +``` + + + + +# Current Presentation +``` +Please specify the current presentation of the documentation. +``` + + + + +# Attachment +``` +Please drag and drop the necessary data files (e.g. screenshot, logs, etc) +below. +``` diff --git a/.gitlab/issue_templates/Feature Enhancement.md b/.gitlab/issue_templates/Feature Enhancement.md new file mode 100644 index 0000000..db6a62c --- /dev/null +++ b/.gitlab/issue_templates/Feature Enhancement.md @@ -0,0 +1,37 @@ +[comment]: # (GitLab Internal Operation Headers) +/label ~"Enhancement" ~"Discussion" +[comment]: # (GitLab Internal Operation Headers) + +# Description +``` +Please provide a short description of what feature you're looking forward to +enhance below. Please include the story behind your idea as well to give a +better visualization of your idea. +``` + + + + +# Expected Behavior +``` +Please specify the expected behavior of your requested enhancement. Some great +and helpful pointers are your expected interface (e.g. command patterns, simple +sketches of the user interface, etc). +``` + + + + +# Current Behavior +``` +Please specify the current behavior (e.g. workaround, blockage, etc). +``` + + + + +# Attachment +``` +Please drag and drop the necessary data files (e.g. screenshot, logs, etc) +below. +``` diff --git a/.gitlab/issue_templates/New Feature Request.md b/.gitlab/issue_templates/New Feature Request.md new file mode 100644 index 0000000..535f17a --- /dev/null +++ b/.gitlab/issue_templates/New Feature Request.md @@ -0,0 +1,37 @@ +[comment]: # (GitLab Internal Operation Headers) +/label ~"New Feature" ~"Discussion" +[comment]: # (GitLab Internal Operation Headers) + +# Description +``` +Please provide a short description of what feature you're looking forward to +add into the existing repository below. Please include the story behind your +idea as well to give a better visualization of your idea. +``` + + + + +# Expected Behavior +``` +Please specify the expected behavior of your requested feature. Some great and +helpful pointers are your expected interface (e.g. command patterns, simple +sketches of the user interface, etc). +``` + + + + +# Current Absent Behavior +``` +Please specify the current behavior (e.g. workaround, blockage, etc). +``` + + + + +# Attachment +``` +Please drag and drop the necessary data files (e.g. screenshot, logs, etc) +below. +``` diff --git a/.gitlab/issue_templates/Question.md b/.gitlab/issue_templates/Question.md new file mode 100644 index 0000000..e2106ff --- /dev/null +++ b/.gitlab/issue_templates/Question.md @@ -0,0 +1,38 @@ +[comment]: # (GitLab Internal Operation Headers) +/label ~"Question" ~"Discussion" +[comment]: # (GitLab Internal Operation Headers) + +# Question +``` +Please state your question in a brief and ended with question mark (?). You may +include sub-questions with "if cases" to communicate more effectively instead of +many 'ping-pong' passing. +``` + + + + +# Background +``` +Please provide a short description of what you are trying to ask. +``` + + + + +# Current Research Artifacts (COMPULSORY) +``` +Please list out all your research artifacts that you did (e.g. link, blog post, +documentations, and etc) for us to gauge your context and current efforts. We +may not reply and will close the ticket if this section remains empty and +unconvincing. +``` + + + + +# Attachment +``` +Please drag and drop the necessary data files (e.g. screenshot, logs, etc) +below. +``` diff --git a/.gitlab/merge_request_templates/default.md b/.gitlab/merge_request_templates/default.md new file mode 100644 index 0000000..6ce6309 --- /dev/null +++ b/.gitlab/merge_request_templates/default.md @@ -0,0 +1,129 @@ +# Prologue +**We DO NOT ACCEPT ANY PULL/MERGE REQUEST FOR THIS REPOSITORY**. + +The right procedure for contributing back via these platform services ARE: + +1. **Generate and submit your patches into your corresponding issue ticket**; +2. Feel free to ask any technical questions about patch generations; +3. Once the basic are cleared, We will `git am` (apply) the submitted patch. If + it works, it will then be treated as accepted. + + + + +# Why? +We want to: + +1. **Retaining all changes and information inside git log ONLY**; and +2. **Avoiding complete vendor locked-in**; and +3. **Continue to facilitate offline and disconnected native git services** + +Like it or not, any GVCS (e.g. GitHub/GitLab/Gitea) are supplying vendors and +they can introduce drastic business changes overtime to the point where we can +terminate their supplying services. + +Hence, to prevent vendor lock-in problem, we are: + +1. use the native `git` functionalities to maintain the source codes; WHILE +2. only use the GVCS to facilitate mirror-ed hosting and communications only. + +In any cases, we do not mind losing the forum but we are very agitated if the +repository maintenance works are unnecessarily being threatened by a known and +identified supply-chain threat. + + + + +# What is Required in Your Commit Messages +**Write the whole ESSAY of the issue ticket you are working on**. Remember the +goal is to capture your commitment from problem to why we should apply your +patch. + +A format template is as follows: + +``` +: # **REQUIRED**: max 65 characters + # **REQUIRED**: LEAVE THIS EMPTY new LINE +[1st Para: explain the issue problem] # **REQUIRED**: explain the problem + # presented by the issue ticket. It's a + # paragraph, so use as long as you want. + # + # line should wrap at MAX 80 characters. + # + # If can, include the submitted + # data problems (e.g. log data). + # + # Mentions about the severity of the + # problem (e.g. workaround? critical?). + # See applied labels. + # + # **REQUIRED**: LEAVE THIS EMPTY new LINE +[2nd Para: explain this patch's work] # Only explains what this patch does for + # its approach to solve the problem + # you mentioned above. It's a + # paragraph, so use as long as you want. + # + # line should wrap at MAX 80 characters. + # + # **REQUIRED**: leave THIS empty new line +Signed-off-by: [NAME] <[EMAIL]> # **REQUIRED**: Your git signature here. +``` + +You can refer to the `git log` for inspirations or just ask us in the issue +ticket you're working on. + +Note that: + +1. You **DO NOT NEED** to explain how the codes work or what are the +files involved. The patch already presented the data. +2. If your effort involves some kind of algorithm explaination, make sure to +include its documentations and mentions where to find them so that your +reviewers know where to digest them. + + + + +## GPG Signature for Commit Signature +**Optional but highly recommended** since we are doing manual code-review and +automated CI testing internally on our side with our own automation tools. + +If you're signing, please provide your public key source so that we can verify +you internally in the future. + + + + +# To Generate Patches +To create your patches, please use any of the following `git` command: + +```bash +$ git format-patch .. +``` + +> Example: +> +> `$ git format-patch fed1235..ab32123` +> `$ git format-patch HEAD~3..HEAD` + +This is recommended since: + +1. The smaller, single-purpose of the patches, the easier to review and accept. + +**OR Alternatively** + +```bash +$ git format-patch ^.. --stdout > my.patch +``` + +> Example: +> +> `$ git format-patch fed1235^..ab32123 --stdout > my.patch` + + + + +# Epilogue +That's all from us. Your pull request **SHALL BE REJECTED WITH PERJUDICE** if +you choose to ignore this message. + +Thank you for your cooperation. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..0d426d4 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,132 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement by raising a +matter forum in the Issues section. All complaints will be reviewed and +investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f68ea48..53077ee 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,16 +1,5 @@ -# CONTRIBUTING GUIDELINES -Thank you for your interest in contributing to this font repository. This -section guides you on how to contribute smoothly and without any hiccups. To -contribute, simply: +The contributing guidelines are documented in its own web documentation portal. +Please visit the following site for more info: -## 1. Create an Issue -First, file an issue here (https://github.com/ZORALab/fonts/issues) stating that -you want to add a particular font file in it. The minimal requirements are: - -1. A PDF or published license file. The license **MUST BE COMPLIANT** to - [Open Font License](LICENSE) as this repository is strictly licensed under - it. -2. Downloaded font artifacts from original source / upload the usable font file - as an attachment. -3. That's it. Our team member will process the rest. +https://hestia.zoralab.com/ diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..76b596f --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,14 @@ +# Security Policy - Reporting a Vulnerability +We take security issues seriously AND WITHOUT CAUSING PUBLIC PANICS. Therefore, +if you find any security vulnerability (both suspicious or confirmed), please +feel free to communicate with my team at: + +``` +security@zoralab.com +``` + +or raise a report under **Report a security vulnerability** title in the Issues +section. + + +**REMEMBER**: DO NOT CAUSE PUBLIC PANICS. Please be professional.