add ci workflows and document stuff

.github/CONTRIBUTING.md

@@ -0,0 +1,72 @@
+# Contributing
+
+## Request for changes/ Pull Requests
+You first need to create a fork of the [payable](https://github.com/unusualify/payable/) repository to commit your changes to it. Methods to fork a repository can be found in the [GitHub Documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
+
+Then add your fork as a local project:
+
+```sh
+# Using HTTPS
+git clone https://github.com/unusualify/payable.git
+
+# Using SSH
+git clone git@github.com:unusualify/payable.git
+```
+
+> [Which remote URL should be used ?](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories)
+
+Then, go to your local folder
+
+```sh
+cd payable
+```
+
+Add git remote controls :
+
+```sh
+# Using HTTPS
+git remote add fork https://github.com/YOUR-USERNAME/payable.git
+git remote add upstream https://github.com/unusualify/payable.git
+
+
+# Using SSH
+git remote add fork git@github.com:YOUR-USERNAME/payable.git
+git remote add upstream git@github.com:unusualify/payable.git
+```
+
+You can now verify that you have your two git remotes:
+
+```sh
+git remote -v
+```
+
+## Receive remote updates
+In view of staying up to date with the central repository :
+
+```sh
+git pull upstream main
+```
+
+## Choose a base branch
+Before starting development, you need to know which branch to base your modifications/additions on. When in doubt, use main.
+
+| Type of change                |           | Branches              |
+| :------------------           |:---------:| ---------------------:|
+| Bug fixes                     |           | `dev`              |
+| New features                  |           | `dev`              |
+| Hot fixes                     |           | `main`              |
+| Documentation                 |           | `main`              |
+| New issues models             |           | `YOUR-USERNAME:patch` |
+
+```sh
+# Switch to the desired branch
+git switch main
+
+# Pull down any upstream changes
+git pull
+
+# Create a new branch to work on
+git switch --create patch/1234-name-issue
+```
+
+Commit your changes, then push the branch to your fork with `git push -u fork` and open a pull request on [the payable repository](https://github.com/unusualify/payable/) following the template provided.

.github/ISSUE_TEMPLATE/1-bug.yml

@@ -0,0 +1,105 @@
+name: "🐛 Bug Report"
+description: Create a new ticket for a bug.
+# title: "🐛 [BUG] - <title>"
+title: "🐛 [BUG]: "
+labels: [
+  "bug"
+]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: "Description"
+      description: Please enter an explicit description of your issue
+      placeholder: Short and explicit description of your incident...
+    validations:
+      required: true
+  - type: dropdown
+    id: severity
+    attributes:
+      label: "Severity"
+      description: Select the severity of the bug (this will determine if it's a hotfix)
+      options:
+        - Low
+        - Medium
+        - High
+        - Critical
+    validations:
+      required: true
+  # - type: dropdown
+  #   id: version
+  #   attributes:
+  #     label: "Version"
+  #     description: Select which version of the software the bug is in
+  #     options:
+  #       - Low
+  #       - Medium
+  #       - High
+  #       - Critical
+  #   validations:
+  #     required: true
+  - type: textarea
+    id: reprod
+    attributes:
+      label: "Reproduction steps"
+      description: Please enter an explicit description of your issue
+      value: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+      render: bash
+    validations:
+      required: true
+  - type: textarea
+    id: screenshot
+    attributes:
+      label: "Screenshots"
+      description: If applicable, add screenshots to help explain your problem.
+      value: |
+        ![DESCRIPTION](LINK.png)
+      # render: bash
+    validations:
+      required: false
+  - type: textarea
+    id: logs
+    attributes:
+      label: "Logs"
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: bash
+    validations:
+      required: false
+  - type: input
+    id: reprod-url
+    attributes:
+      label: "Reproduction URL"
+      description: Please enter your GitHub URL to provide a reproduction of the issue
+      placeholder: ex. https://github.com/USERNAME/REPO-NAME
+    validations:
+      required: false
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: "Browsers"
+      description: What browsers are you seeing the problem on ?
+      multiple: true
+      options:
+        - Firefox
+        - Chrome
+        - Safari
+        - Microsoft Edge
+        - Opera
+    validations:
+      required: false
+  - type: dropdown
+    id: os
+    attributes:
+      label: "OS"
+      description: What is the impacted environment ?
+      multiple: true
+      options:
+        - Windows
+        - Linux
+        - Mac
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/2-feature.yml

@@ -0,0 +1,31 @@
+name: "💡 Feature Request"
+description: Create a new ticket for a new feature request
+# title: "💡 [REQUEST] - <title>"
+title: "💡 [FEATURE]: "
+labels: [
+  "enhancement",
+]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: "Description"
+      description: Provide a brief explanation of the feature
+      placeholder: Describe in a few lines your feature request
+    validations:
+      required: true
+  - type: textarea
+    id: basic_example
+    attributes:
+      label: "Basic Example"
+      description: Indicate here some basic examples of your feature.
+      placeholder: A few specific words about your feature request.
+    validations:
+      required: true
+  - type: textarea
+    id: screenshot
+    attributes:
+      label: "Screenshots"
+      description: If applicable, add screenshots to help explain your problem.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/3-documentation.yml

@@ -0,0 +1,44 @@
+name: "📚 Documentation"
+description: Create a new ticket for documentation
+title: "📚 [DOCS]: "
+labels: [
+  "documentation"
+]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: "Description"
+      description: Provide a brief explanation of what documentation is needed
+      placeholder: Describe what documentation needs to be added or updated
+    validations:
+      required: true
+  - type: dropdown
+    id: doc_type
+    attributes:
+      label: "Documentation Type"
+      description: Select the type of documentation needed
+      options:
+        - API Documentation
+        - User Guide
+        - Developer Guide
+        - Installation Guide
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    id: current_documentation
+    attributes:
+      label: "Current Documentation"
+      description: If this is an update, please provide links to the current documentation
+      placeholder: Links to existing documentation or N/A if this is new
+    validations:
+      required: false
+  - type: textarea
+    id: proposed_changes
+    attributes:
+      label: "Proposed Changes"
+      description: Describe the specific changes or additions needed
+      placeholder: List the specific sections or topics that need to be documented
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/4-performance.yml

@@ -0,0 +1,59 @@
+name: "⚡ Performance Issue"
+description: Create a new ticket for a performance issue or optimization request
+title: "⚡ [PERF]: "
+labels: [
+  "performance"
+]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: "Description"
+      description: Please describe the performance issue in detail
+      placeholder: Explain what performance problem you're experiencing...
+    validations:
+      required: true
+  - type: textarea
+    id: current_behavior
+    attributes:
+      label: "Current Performance"
+      description: Describe the current performance metrics or behavior
+      placeholder: e.g., Page takes 5 seconds to load, API response time is 3 seconds
+    validations:
+      required: true
+  - type: textarea
+    id: expected_behavior
+    attributes:
+      label: "Expected Performance"
+      description: Describe what performance level you expect or need
+      placeholder: e.g., Page should load within 2 seconds, API should respond within 500ms
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: "Steps to Reproduce"
+      description: Please provide steps to reproduce the performance issue
+      value: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Observe performance issue
+    validations:
+      required: true
+  - type: textarea
+    id: metrics
+    attributes:
+      label: "Performance Metrics"
+      description: If available, provide any performance metrics, profiling data, or benchmarks
+      render: bash
+    validations:
+      required: false
+  - type: textarea
+    id: screenshot
+    attributes:
+      label: "Screenshots/Recordings"
+      description: If applicable, add screenshots or recordings showing the performance issue
+      value: |
+        ![DESCRIPTION](LINK.png)
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/5-question.yml

@@ -0,0 +1,40 @@
+name: "❓ Question"
+description: Create a new ticket for a question
+title: "❓ [QUESTION]: "
+labels: [
+  "question"
+]
+body:
+  - type: textarea
+    id: question
+    attributes:
+      label: "Question"
+      description: Please provide your question with as much detail as possible
+      placeholder: Describe what you're trying to understand or accomplish...
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: "Context"
+      description: Provide any relevant context or background information
+      placeholder: What have you tried? What documentation have you read?
+    validations:
+      required: true
+  - type: textarea
+    id: examples
+    attributes:
+      label: "Code Examples"
+      description: If applicable, provide code examples related to your question
+      render: bash
+    validations:
+      required: false
+  - type: textarea
+    id: screenshot
+    attributes:
+      label: "Screenshots"
+      description: If applicable, add screenshots to help explain your question
+      value: |
+        ![DESCRIPTION](LINK.png)
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,29 @@
+## Checklist
+<!--- Please make sure all the following are checked before submitting: -->
+- [ ] I have read the **CONTRIBUTING** document.
+- [ ] My code follows the code style of this project.
+- [ ] My change requires a change to the documentation.
+- [ ] I have updated the documentation accordingly.
+- [ ] I have added tests to cover my changes.
+- [ ] All new and existing tests passed.
+
+
+## Types of changes
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] feat: A new feature
+- [ ] fix: A bug fix
+- [ ] docs: Documentation only changes
+- [ ] style: Changes that do not affect the meaning of the code (white-space, formatting, etc)
+- [ ] refactor: A code change that neither fixes a bug nor adds a feature
+- [ ] perf: A code change that improves performance
+- [ ] test: Adding missing tests or correcting existing tests
+- [ ] build: Changes that affect the build system or external dependencies
+- [ ] ci: Changes to our CI configuration files and scripts
+- [ ] chore: Other changes that don't modify src or test files
+- [ ] revert: Reverts a previous commit
+
+## Description
+<!--- Please describe your changes in detail -->
+
+## Related Issue
+<!--- Please link to the issue here if applicable: -->