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.md b/.github/ISSUE_TEMPLATE/Bug.md deleted file mode 100644 index 39cf8ba..0000000 --- a/.github/ISSUE_TEMPLATE/Bug.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -name: "Bug Report" -about: "use for reporting bug/gitches regarding the repository." -labels: "Bug, Discussion" ---- - -# 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. -``` - - - - -# Attachments -``` -Please drag and drop the necessary data files (e.g. screenshot, logs, etc) -below. -``` 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 Problem.md b/.github/ISSUE_TEMPLATE/Documentation Problem.md deleted file mode 100644 index 205a40d..0000000 --- a/.github/ISSUE_TEMPLATE/Documentation Problem.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -name: "Documentation Problem" -about: "use for reporting documentation problem regarding the repository." -labels: "Documentation, Discussion" ---- - -# 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/.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/Feature Enhancement.md b/.github/ISSUE_TEMPLATE/Feature Enhancement.md deleted file mode 100644 index 71a7bbc..0000000 --- a/.github/ISSUE_TEMPLATE/Feature Enhancement.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: "Feature Enhancement Request" -about: "use for requesting a feature enhancement for the repository" -labels: "Enhancement, Discussion" ---- - -# 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/.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 Feature Request.md b/.github/ISSUE_TEMPLATE/New Feature Request.md deleted file mode 100644 index 5f79483..0000000 --- a/.github/ISSUE_TEMPLATE/New Feature Request.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: "New Feature Request" -about: "use for requesting new feature for the repository" -labels: "New Feature, Discussion" ---- - -# 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/.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.md b/.github/ISSUE_TEMPLATE/Question.md deleted file mode 100644 index a5dac9d..0000000 --- a/.github/ISSUE_TEMPLATE/Question.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -name: "Question" -about: "use for clarifying a researched uncertainty regarding the repository." -labels: "Question, Discussion" ---- - -# 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 with perjuidice 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/.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 index 6ce6309..984a426 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -1,4 +1,5 @@ # Prologue + **We DO NOT ACCEPT ANY PULL/MERGE REQUEST FOR THIS REPOSITORY**. The right procedure for contributing back via these platform services ARE: @@ -12,6 +13,7 @@ The right procedure for contributing back via these platform services ARE: # Why? + We want to: 1. **Retaining all changes and information inside git log ONLY**; and @@ -35,6 +37,7 @@ 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. @@ -84,6 +87,7 @@ 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. @@ -94,6 +98,7 @@ you internally in the future. # To Generate Patches + To create your patches, please use any of the following `git` command: ```bash @@ -123,6 +128,7 @@ $ git format-patch ^.. --stdout > my.patch # Epilogue + That's all from us. Your pull request **SHALL BE REJECTED WITH PERJUDICE** if you choose to ignore this message. 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..dec4c8a --- /dev/null +++ b/.github/workflows/git-push.yml @@ -0,0 +1,47 @@ +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 + 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 SH-CMD + id: native_ci_SH-CMD + run: | + ./posix-batch.sh.cmd + - name: Execute SH-PS1-CMD + id: native_ci_SH-PS1-CMD + run: | + ./posix-batch-powershell.sh.ps1.cmd + - name: Execute Powershell SH-CMD + id: native_ci_PS1-SH-CMD + run: | + ./posix-powershell.sh.cmd + - name: Execute Powershell SH-PS1 + id: native_ci_SH-PS1 + run: | + ./posix-powershell.sh.ps1 diff --git a/.gitignore b/.gitignore index 350a6c5..0d278db 100644 --- a/.gitignore +++ b/.gitignore @@ -5,14 +5,7 @@ ##################### # Standard FHS ##################### -docs/resources/ -themes/ -*.log -.bin/ vendor/ -gh-pages/ -bin/ -tmp/ output/ /releases/ !/*/releases/ @@ -22,15 +15,57 @@ output/ ##################### /.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 ##################### +themes/ public/ .hugo_build.lock @@ -45,7 +80,7 @@ certbot.log /build ##################### -# vim specifics +# vim ##################### 4913 *.swp @@ -56,14 +91,48 @@ certbot.log *.d !*.d/ *.o +*.a +*.dll +*.exe *.elf *.hex *.bin +##################### +# 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 diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..0edfd19 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,45 @@ +# WARNING: auto-generated by AutomataCI + +cff-version: "1.2.0" +type: "software" +date-released: "2024-02-19" +title: "Polygot Scripts" +version: "1.3.0" +license: "MIT" +repository: "https://github.com/ChewKeanHo/PolygotScripts" +repository-code: "https://github.com/ChewKeanHo/PolygotScripts" +repository-artifact: "https://github.com/ChewKeanHo/PolygotScripts" +url: "https://github.com/ChewKeanHo/PolygotScripts" +contact: + - affiliation: "(Holloway) Chew, Kean Ho" + email: "hello@hollowaykeanho.com" + website: "https://www.hollowaykeanho.com" +abstract: |- + A single executable script format that is operable in both UNIX and WINDOWS + environment. +message: |- + Please cite and reference this repository accordingly. +authors: + - given-names: "Kean Ho" + family-names: "Chew" + email: "hollowaykeanho@gmail.com" + affiliation: "Independent" + orcid: "https://orcid.org/0000-0003-4202-4863" + - given-names: "Cory" + family-names: "Galyna" + email: "124406765+corygalyna@users.noreply.github.com" + affiliation: "Independent" +identifiers: + - type: doi + value: "10.5281/zenodo.000000" + description: "Paper" +keywords: + - "windows" + - "macos" + - "linux" + - "unix" + - "powershell" + - "batch-script" + - "powershell-script" + - "polygot" + - "posix-shell" 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/LICENSE b/LICENSE.txt similarity index 100% rename from LICENSE rename to LICENSE.txt diff --git a/README.md b/README.md index 9543cb2..39a3eb7 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,8 @@ initialization where maintaining multi-OSes end products can be easily done. ## Why It Matters Mainly for multi-os decentralized packaging usage: -1. **1 common start point** - less communication errors; more control over the - package installation. +1. **1 common starting point** - less communication errors; more control over + the package installation. 2. **Maintainable and documentable** - 1 single start point; 1 set of documentation only; 1 easy way to maintain the starting point command. 3. **Simple and modular** - can easily drill down the errors due to @@ -30,18 +30,23 @@ The products are located in the root repository in various versions: 1. POSIX Shell mode; AND 2. BATCH mode; AND 3. POWERSHELL mode. + 2. [posix-batch.sh.cmd](posix-batch.sh.cmd) - capable of running in: 1. POSIX Shell mode; AND 2. BATCH mode; AND - > [!NOTE] - > PowerShell knows how to execute batch script. No auto-correction is - > required. + +> [!NOTE] +> PowerShell knows how to execute batch script. No auto-correction is +> required. + 3. [posix-powershell.sh.cmd](posix-powershell.sh.cmd) - capable of running in: 1. POSIX Shell mode; AND 2. POWERSHELL mode. - > [!IMPORTANT] - > When executed in Batch mode, it will auto-correct itself to PowerShell and - > execute it from there. + +> [!IMPORTANT] +> When executed in Batch mode, it will auto-correct itself to PowerShell and +> execute it from there. + 4. [posix-powershell.sh.ps1](posix-powershell.sh.ps1) - capable of running in: 1. POSIX Shell mode; AND 2. POWERSHELL mode. @@ -77,8 +82,9 @@ initializing command rather than develop a [fat binary](https://en.wikipedia.org/wiki/Fat_binary) like executable script. In case you don't know, coding all 3 types of scripts and compile into 1 -manually can be a cumbersome task as they can easily become large. Should it be -too complex, you should use proper programming languages like Go or Rust. +manually can be a cumbersome task as the output file can easily become 3x +larger. Should it be too complex, you should use proper programming languages +like Go or Rust. Please **DO NOT abuse it. You have been warned!** @@ -86,4 +92,4 @@ Please **DO NOT abuse it. You have been warned!** ## License -This project is licensed under [MIT License](LICENSE). +This project is licensed under [MIT License](LICENSE.txt). diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..a44dfb4 --- /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@hollowaykeanho.com +``` + +or raise a report under **Report a security vulnerability** title in the Issues +section. + + +**REMEMBER**: DO NOT CAUSE PUBLIC PANICS. Please be professional.