Normalise with latest scaffolding (#4)

* Normalize the code structure with baldrick-ts version 0.14.0
See https://github.com/flarebyte/baldrick-ts/releases

* Adds scripts to generate readme cli doc

Author: olih

.aliases.zsh

@@ -0,0 +1,3 @@
+alias bpub='npx baldrick-dev-ts release ci'
+alias gcf='git add . && git commit -F .message && rm .message'
+alias yig='yarn global add $PWD'

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,51 @@
+name: Bug Report
+description: File a bug report
+title: "[Bug]: "
+labels:
+  - bug
+  - triage
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Please tell us, what did you expect to happen?
+      placeholder: Tell us what you see!
+      value: A bug happened!
+    validations:
+      required: true
+  - type: textarea
+    id: version
+    attributes:
+      label: Version
+      description: What version of the library are you running?
+      placeholder: 0.0.0
+    validations:
+      required: true
+  - type: dropdown
+    id: platform
+    attributes:
+      label: On which platform(s) do you have the issue ?
+      multiple: true
+      options:
+        - Node.js
+        - Typescript node
+        - Firefox
+        - Chrome
+        - Safari
+        - Microsoft Edge
+        - Linux
+        - Windows
+        - MacOs
+        - Other
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be
+        automatically formatted into code, so no need for backticks.
+      render: shell

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,56 @@
+name: Feature request
+description: Suggest an idea for this project
+title: "[Feature]: "
+labels:
+  - feature
+  - triage
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this feature request!
+  - type: textarea
+    id: problem
+    attributes:
+      label: Describe the problem
+      description: Is your feature request related to a problem? Please describe.
+      placeholder: Describe the problem you would like to solve
+      value: My problem
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution
+      description: A clear and concise description of what you want to happen.
+      placeholder: Tell us what you would like to see!
+      value: My solution
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.
+      placeholder: A context
+      value: The context
+    validations:
+      required: true
+  - type: checkboxes
+    id: suitability
+    attributes:
+      label: Is this new feature a good fit ?
+      description: Should this new feature really be part of this project
+      options:
+        - label: "__Needed__: an existing user is going to need this in the short term"
+          required: true
+        - label: "__Specific__: the problem is clearly understood and defined"
+          required: true
+        - label: "__Small change__: This new feature represents a reasonably small change"
+          required: true
+        - label: "__Same scope__: this new feature does not change significantly the scope
+            of this project"
+          required: true
+        - label: "__Long term maintenance__: moving this to a new project would make long
+            term maintenance harder"
+          required: true

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,17 +1,33 @@
+# Summary of the change
 
+Fixes: # (issue)
 
-# Summary of the change 
+## Code check
 
-Fixes # (issue)
+-   [ ] `yarn ready` does not show any concerning issues
+-   [ ] the project can be built
+-   [ ] the documentation has been updated
+-   [ ] the version has been updated in `package.json`
 
-# Type of change
+## Type of change
 
-- [ ] Bug fix (non-breaking change which fixes an issue)
-- [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+-   [ ] Bug fix (non-breaking change which fixes an issue)
 
-# Motivation and context
+-   [ ] New feature (non-breaking change which adds functionality)
 
+-   [ ] Breaking change (fix or feature that would cause existing
+    functionality to not work as expected)
 
-# How Has This Been Tested?
+## Motivation and context
 
+-   [ ] improve user experience
+-   [ ] improve consistency
+-   [ ] improve security
+-   [ ] improve documentation
+-   [ ] reduce risk for unfamiliar tasks
+-   [ ] automate repetitive tasks
+
+## How Has This Been Tested
+
+-   [ ] Unit tests
+-   [ ] Manual tests

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -28,3 +28,5 @@ jobs:
         run: yarn test:ci
       - name: Build
         run: yarn build
+      - name: Version
+        run: yarn release:check

.github/pull_request_template.md

@@ -2,4 +2,5 @@
 .DS_Store
 node_modules/
 dist/
-report/
+report/
+.message

.github/workflows/main.yml

@@ -1,47 +1,82 @@
-
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project
+and our community a harassment-free experience for everyone, regardless of
+age, body size, disability, ethnicity, gender identity and expression, level
+of experience, nationality, personal appearance, race, religion, or sexual
+identity and orientation.
 
 ## Our Standards
 
-Examples of behavior that contributes to creating a positive environment include:
+Examples of behavior that contributes to creating a positive environment
+include:
 
-- Using welcoming and inclusive language
-- Being respectful of differing viewpoints and experiences
-- Gracefully accepting constructive criticism
-- Focusing on what is best for the community
-- Showing empathy towards other community members
+-   Using welcoming and inclusive language
+-   Being respectful of differing viewpoints and experiences
+-   Gracefully accepting constructive criticism
+-   Focusing on what is best for the community
+-   Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-- The use of sexualized language or imagery and unwelcome sexual attention or advances
-- Trolling, insulting/derogatory comments, and personal or political attacks
-- Public or private harassment
-- Publishing others' private information, such as a physical or electronic address, without explicit permission
-- Other conduct which could reasonably be considered inappropriate in a professional setting
+-   The use of sexualized language or imagery and unwelcome sexual
+    attention or advances
+
+-   Trolling, insulting/derogatory comments, and personal or political
+    attacks
+
+-   Public or private harassment
+
+-   Publishing others' private information, such as a physical or
+    electronic address, without explicit permission
+
+-   Other conduct which could reasonably be considered inappropriate in a
+    professional setting
 
 ## Our Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+Project maintainers are responsible for clarifying the standards of
+acceptable behavior and are expected to take appropriate and fair corrective
+action in response to any instances of unacceptable behavior.
 
-Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an
+appointed representative at an online or offline event. Representation of a
+project may be further defined and clarified by project maintainers.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [Flarebyte.com](https://github.com/flarebyte). The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at
+[Flarebyte.com](https://github.com/flarebyte). The project team will review
+and investigate all complaints, and will respond in a way that it deems
+appropriate to the circumstances. The project team is obligated to maintain
+confidentiality with regard to the reporter of an incident. Further details
+of specific enforcement policies may be posted separately.
 
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at
+[http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
+
 [version]: http://contributor-covenant.org/version/1/4/