Merge pull request #10 from MasterLaplace/dev

Dev

.gitattributes

@@ -0,0 +1,25 @@
+# Line endings
+* text eol=lf
+
+# Binary files
+*.jpg binary
+*.png binary
+*.obj binary
+*.o binary
+*.a binary
+*.lib binary
+*.dll binary
+*.so binary
+*.dylib binary
+*.exe binary
+*.out binary
+*.app binary
+
+# Handling of C-specific and C++-specific files
+*.c linguist-language=C
+*.cpp linguist-language=C++
+*.h linguist-language=C
+*.hpp linguist-language=C++
+
+# Handling of Python-specific files
+*.py linguist-language=Python

.github/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 at
+[INSERT CONTACT METHOD].
+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

.github/FUNDING.md

@@ -0,0 +1,17 @@
+# Support this Project
+
+If you find this project useful and would like to provide financial support, we would greatly appreciate it. Your support helps us continue to develop and maintain this project.
+
+## Funding Methods
+
+- [GitHub Sponsors](https://github.com/sponsors/MasterLaplace)
+
+## Benefits for Financial Contributors
+
+As a financial contributor, you will receive the following benefits:
+
+- Early access to new features.
+- Special mention in our documentation.
+- Access to our private discussion channel for direct discussions with the team.
+
+We thank you for your ongoing support!

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [MasterLaplace]

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,30 @@
+name: Report a bug
+description: Report a bug
+title: '[Bug]: '
+labels:
+  - bug
+body:
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Tell us what happened
+    validations:
+      required: true
+  - type: textarea
+    id: what-should-happened
+    attributes:
+      label: 'What should have happened?'
+    validations:
+      required: true
+  - type: textarea
+    id: log
+    attributes:
+      label: LOG
+      description: If you have log, please send it to us!
+  - type: checkboxes
+    attributes:
+      label: I read the Code Of Conduct
+      options:
+        - label: I read the Code Of Conduct and I comply to it
+          required: true

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,27 @@
+name: Feature request
+description: Suggest an idea for this project
+title: '[Feature]: '
+assignees:
+  - {{ github.actor }}
+labels:
+  - enhancement
+body:
+  - type: input
+    id: featureName
+    attributes:
+      label: Feature name
+    validations:
+      required: true
+  - type: textarea
+    id: featureContent
+    attributes:
+      label: Explain the feature
+      description: Tell us what we should add
+    validations:
+      required: true
+  - type: checkboxes
+    attributes:
+      label: I read the Code Of Conduct
+      options:
+        - label: I read the Code Of Conduct and I comply to it
+          required: true

.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,24 @@
+name: I have a question
+description: Ask you question, we will answer in documentation () and below your question
+title: '[Question]: '
+labels:
+  - enhancement
+body:
+  - type: input
+    id: questionAbout
+    attributes:
+      label: What is your question is about ?
+    validations:
+      required: true
+  - type: textarea
+    id: questionContent
+    attributes:
+      label: Ask your question here
+    validations:
+      required: true
+  - type: checkboxes
+    attributes:
+      label: I read the Code Of Conduct
+      options:
+        - label: I read the Code Of Conduct and I comply to it
+          required: true

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,23 @@
+## Changes
+
+**This pull request makes the following changes:**
+
+> - what changed?
+
+## Standards checklist:
+
+**Questions that need to be answered before merging:**
+
+- [ ] The PR title is descriptive.
+- [ ] The PR doesn't replicate another PR which is already open.
+- [ ] Is this PR targeting the correct branch in this repository?
+- [ ] Has the `CHANGELOG.md` file been updated to reflect the updates in this PR?
+- [ ] The code is well documented and easy to understand.
+
+## Additional information
+
+**Area Dino Client requesting: (if applicable)**
+
+- [ ] Contributor has read Area Dino's [GitHub code of conduct](https://MasterLaplace/Flakkari/blob/main/.github/CODE_OF_CONDUCT.md)
+- [ ] Contributor would like to be mentioned in the release notes as: (fill in this blank)
+- [ ] Contributor agrees to the license terms of this repository.

.github/SUPPORT.md

@@ -0,0 +1,33 @@
+# Support for Flakkari
+
+Welcome to the support center for Flakkari! If you have questions, encounter issues, or need assistance, you're in the right place.
+
+## Reporting Issues
+
+If you come across a bug or want to report an enhancement, please open a new issue on GitHub. Be sure to provide as much information as possible, including reproduction steps and screenshots if appropriate.
+
+[Open a New Issue](https://github.com/MasterLaplace/Flakkari/issues/new)
+
+## Questions and Discussions
+
+For general questions or discussions about Flakkari, we encourage you to use GitHub Discussions. It's a great place to discuss ideas, share tips, and ask questions that are not directly related to specific issues.
+
+[Access Discussions](https://github.com/MasterLaplace/Flakkari/discussions)
+
+## Additional Resources
+
+Make sure to check out our documentation for detailed information on installing, configuring, and using Flakkari.
+
+[Access Documentation](https://github.com/MasterLaplace/Flakkari/wiki)
+
+Please note that Flakkari is an open-source project, and we rely on the community to provide support. If you have technical skills and wish to help others, we encourage you to become an active contributor to the project.
+
+Thank you for your interest in Flakkari, and we look forward to assisting you!
+
+**Note:** Please adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) during all community interactions related to Flakkari.
+
+## Question Template
+
+If you have a question and need assistance, you can use our question template to provide more context and structure to your inquiry.
+
+[Open a New Question](https://github.com/MasterLaplace/Flakkari/issues/new?assignees=&labels=question&template=.github/ISSUE_TEMPLATE/question.yml)

.github/workflows/build_checker.yml

@@ -0,0 +1,29 @@
+name: Build Checker
+
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  verify-commit-name:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Set up Git repository
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: |
+            sudo apt update
+            sudo apt install cmake
+
+      - name: Build
+        run: |
+            mkdir build
+            cd build
+            cmake ..
+            cmake --build .

.github/workflows/commit_norm_check.yml

@@ -0,0 +1,32 @@
+name: Commit Norm Checker
+
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  verify-commit-name:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Set up Git repository
+        uses: actions/checkout@v4
+
+      - name: Commit Norm Checker
+        run: |
+          commit_msg=$(git log --format=%B -n 1 ${{ github.sha }})
+          keyword_regex="^([a-z]+\([A-Za-z_.-]+\)|^[a-z]+): "
+
+          if [[ ! $commit_msg =~ $keyword_regex ]]; then
+            if [[ $commit_msg =~ ^Merge\ .* ]]; then
+              echo "Skipping merge commit"
+            else
+              echo $commit_msg
+              echo "Commit message does not match expected format. Please use the following format: \"keyword(scope): comment\""
+              exit 1
+            fi
+          fi