From 40d077aa39d7ba185caf8e54ebb9f9f1e990165e Mon Sep 17 00:00:00 2001 From: Sacha Dujardin Date: Thu, 20 Jun 2024 14:05:50 +0200 Subject: [PATCH] Initial commit --- .github/ISSUE_TEMPLATE/bug_report.yml | 71 +++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 45 +++++ .github/assets/.gitkeep | 0 .github/getting-started.md | 204 +++++++++++++++++++++ .github/milestone_template.md | 26 +++ .github/pull_request_template.md | 31 ++++ .github/release-drafter.yml | 41 +++++ .github/workflows/release-drafter.yml | 27 +++ .gitignore | 0 CONTRIBUTING.md | 112 +++++++++++ LICENSE | 201 ++++++++++++++++++++ README.md | 68 +++++++ 12 files changed, 826 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/assets/.gitkeep create mode 100644 .github/getting-started.md create mode 100644 .github/milestone_template.md create mode 100644 .github/pull_request_template.md create mode 100644 .github/release-drafter.yml create mode 100644 .github/workflows/release-drafter.yml create mode 100644 .gitignore create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 README.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..3a61576 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,71 @@ +name: Bug Report +description: File a bug report +title: "[Bug]: " +labels: ["bug", "triage"] +assignees: + - adrienfort # Update it +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: description + attributes: + label: Description + description: Describe your bug shortly. + placeholder: Tell us what you see! + value: "A bug happened!" + validations: + required: true + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Describe your bug with as much details as possible. + placeholder: Tell us what you see! + value: "A bug happened!" + validations: + required: true + - type: textarea + id: expected-behaviour + attributes: + label: Expected behaviour + description: Describe what should happened with as much details as possible. + placeholder: Tell us what should happened! + value: "This should happened!" + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment + description: Describe your environment with as much details as possible. + placeholder: Tell us what is your environment! + value: "- OS and version\n- Branch that causes this bug" + validations: + required: true + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to reproduce + description: List the steps to reproduce with as much details as possible. + placeholder: Tell us how to reproduce this bug! + value: "- You have to do this!\n- Then this!" + validations: + required: true + - 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: C++ + validations: + required: false + - type: textarea + id: proposed-solution + attributes: + label: Proposed solution + description: If you have an idea of how to fix this issue, please write it down here, so we can begin discussing it. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..5545497 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,45 @@ +name: Feature Request +description: File a feature request +title: "[Feature]: " +labels: ["feature", "triage"] +assignees: + - adrienfort # Update it +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature request! + - type: textarea + id: description + attributes: + label: Description + description: Describe your feature shortly. + placeholder: Tell us what you want to see! + value: "A new feature!" + validations: + required: true + - type: textarea + id: expected-behaviour + attributes: + label: Expected behaviour + description: Describe what you want to happen with as much details as possible. + placeholder: Tell us what you want to happen! + value: "This should happened!" + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment + description: Describe your environment with as much details as possible. + placeholder: Tell us what is your environment! + value: "- OS and version" + validations: + required: true + - type: textarea + id: proposed-solution + attributes: + label: Proposed solution + description: If you have an idea of how to realise this feature, please write it down here, so we can begin discussing it. + validations: + required: false diff --git a/.github/assets/.gitkeep b/.github/assets/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/.github/getting-started.md b/.github/getting-started.md new file mode 100644 index 0000000..af2dab6 --- /dev/null +++ b/.github/getting-started.md @@ -0,0 +1,204 @@ +# Getting Started + +> [PoC Innovation's Open-Source project template](https://github.com/PoCInnovation/open-source-project-template) + +Please read carefully this guide. + +## Setup + +In this part, you will configure your project. + +### Branches + +Branch protection is really important. It helps you to have control on your code. + +For each of the following branches, add the required protections. + +#### `main` + +```markdown +- [x] Require a pull request before merging + - [x] Require approvals + Required number of approvals before merging: 1 + +- [x] Require status checks to pass before merging + - [x] Require branches to be up to date before merging + +- [x] Require conversation resolution before merging +``` + +### Documents + +This template provides the must-have documents. + +#### README.md + +The README.md is the showcase of your project. It always must be clean and consistent. Otherwise, no one will care of your project. + +Fill every sections of the [README.md](/README.md). +> If you add pictures, put them in the [assets](./assets/) folder. + +#### CONTRIBUTING.md + +The CONTRIBUTING.md is the guide to contribute to your project. It always must be clean and consistent. Otherwise, no one will contribute to your project. + +Fill every sections of the [CONTRIBUTING.md](/CONTRIBUTING.md). + +#### LICENSE + +The LICENSE protects your code and contributors. + +This template provides an [Apache Licence 2.0](https://www.apache.org/licenses/LICENSE-2.0). +> If you want another one, check this [guide](https://choosealicense.com). + +If your project doesn't belong to [PoC Innovation](https://github.com/PoCInnovation), make sure to update the copyrights of the [LICENCE](/LICENSE). + +### About + +Update the `About` section by adding a description, a website, and topics. + +### Templates + +This template provides the must-have templates. + +#### Issues + +An issue is a tool to track and focus tasks. + +This template provides two issues templates : +- `Bug Report` +- `Feature Request` + +Change the default assignee of the [bug_report](./ISSUE_TEMPLATE/bug_report.yml) template. + +Change the default assignee of the [feature_request](./ISSUE_TEMPLATE/feature_request.yml) template. + +#### Pull Requests + +A pull request is an event where a contributor asks a maintainer to review code. + +This template provides a [pull request template](./pull_request_template.md). You don't need to update it. + +#### Milestones + +A milestone helps to track progress on groups of issues or pull requests. + +This template provides a [milestone template](./milestone_template.md). You don't need to update it. + +### Labels + +A label helps to categorize issues and pull requests. + +Make sure to have the following labels : + +- `bug`: Something isn't working +- `bugfix`: Resolve a bug +- `chore`: Global maintenance +- `documentation`: Improvements or additions to documentation +- `duplicate`: This issue or pull request already exists +- `enhancement`: New feature or request +- `help wanted`: Extra attention is needed +- `invalid`: This doesn't seem right +- `major`: Major update (for release) +- `minor`: Minor update (for release) +- `patch`: Patch update (for release) +- `question`: Further information is requested +- `triage`: Need to be tagged +- `wontfix`: This will not be worked on + +### GitHub project + +Create a GitHub project to manage your milestones, issues and pull requests. + +### Actions + +This template provides some GitHub actions. + +#### Release Drafter + +A release is tool with changelogs that present a full history of a project. + +This template provides an [action](./workflows/release-drafter.yml) that drafts [next releases notes](./release-drafter.yml) as pull requests are merged into the main branch. You don't need to update it. +> Check this [action's documentation](https://github.com/release-drafter/release-drafter) to understand how it works + +### Settings + +#### Visibility + +Make your repository public. + +## Sprints + +In this part, you will learn how to manage sprints. + +A sprint is associated as a milestone.\ +A task is associated as an issue. + +### Workflow + +The workflow to follow is: + +1) Create a milestone +2) Create all the needed issues linked to this milestone +3) Manage the pull requests linked with these issues using the GitHib project +4) Resolve these issues +5) Publish a release +6) Close the milestone + +### Milestones + +Each milestones must use the [milestone template](./milestone_template.md). + +There are two parts : +- Overall + > **⚠️ It's checklist must be completed before starting this sprint ⚠️** +- Final Report + > **⚠️ It's checklist must be completed before starting a new sprint ⚠️** + +Additional information is written in the milestones's checklists. Read them carefully! + +### Issues + +Create all the required issues of a sprint before starting it. Once the sprint started, no issue linked to it should be create. + +**Each issue must be linked to a milestone and a GitHub project, have the right labels and be assigned to someone.** + +You can discuss in a issue, do it as much as you can! + +### Pull Requests + +**Each pull request must be linked to an issue and a GitHub project, have the right labels, be assigned to someone and have a reviewer.** + +You can discuss in a pull request, do it as much as you can! + +### GitHub project + +**No tasks (issue) must be created directly from the GitHub project. Create an issue using a template, it will automatically appears on the GitHub project. Don't forget to archive the tasks once the milestone is closed.** + +It is a powerful tool, use it well! + +### Releases + +**Each update on the main branch must be linked to a release.** + +Tag pull requests with the `patch`, `minor` or `major` labels. + +## Notes + +### Discord Webhook + +We strongly advice you to have a discord channel on which you will receive GitHub updates on your project. + +Follow this [tutorial](https://gist.github.com/SGTGunner/50d6a3cc0d489cf779f77695ba3e22ea). + +### Security dependabot + +We strongly advice you to have a security dependabot to fix vulnerable dependencies. + +Follow this [tutorial](https://docs.github.com/en/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates#managing-dependabot-security-updates-for-your-repositories). + +### Help + +If you have any questions, please contact [Reza Rahemtola](https://github.com/RezaRahemtola). + +> Made with ❤️ by PoC diff --git a/.github/milestone_template.md b/.github/milestone_template.md new file mode 100644 index 0000000..69090de --- /dev/null +++ b/.github/milestone_template.md @@ -0,0 +1,26 @@ +## Overall + +### Objective + +[Explain here the objective of the milestone] + +### Checklist + +- [ ] Clear objective +- [ ] Consistent objective +- [ ] Achievable in the given time +- [ ] Issues created, with the rights labels and linked to this milestone +- [ ] Issues assigned + +## Final Report + +### Checklist + +- [ ] Objective fulfilled +- [ ] README.md and other relevant documents (guide, ...) updated +- [ ] Documentation updated +- [ ] Pull requests merged +- [ ] Issues closed +- [ ] Release created +- [ ] Tasks archived +- [ ] Branches cleared diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..a21c702 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,31 @@ +# Description + +Please provide a detailed description of what was done in this PR. +Precise the issue that you are resolving. + +# Changes include + +- [ ] Bugfix (non-breaking change that solves an issue) +- [ ] New feature (non-breaking change that adds functionality) +- [ ] Breaking change (change that is not backwards-compatible and/or changes current functionality) + +# Breaking changes + +Please complete this section if any breaking changes have been made, otherwise delete it. + +# Checklist + +- [ ] I have assigned this PR to myself +- [ ] I have added at least 1 reviewer +- [ ] I have added the needed labels +- [ ] I have linked this PR to an issue +- [ ] I have linked this PR to a milestone +- [ ] I have linked this PR to a project +- [ ] I have tested this code +- [ ] I have added / updated tests (unit / functional / end-to-end / ...) +- [ ] I have updated the README and other relevant documents (guides...) +- [ ] I have added sufficient documentation both in code, as well as in the READMEs + +# Additional comments + +Please post additional comments in this section if you have them, otherwise delete it. \ No newline at end of file diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml new file mode 100644 index 0000000..46291a5 --- /dev/null +++ b/.github/release-drafter.yml @@ -0,0 +1,41 @@ +name-template: 'v$RESOLVED_VERSION 🌈' +tag-template: 'v$RESOLVED_VERSION' +categories: + - title: '🚀 Features' + collapse-after: 5 + labels: + - 'feature' + - 'enhancement' + - title: '🐛 Bug Fixes' + collapse-after: 5 + labels: + - 'fix' + - 'bugfix' + - 'bug' + - title: '🧰 Maintenance' + collapse-after: 5 + labels: + - 'chore' + - 'dependencies' + - title: '📄 Documentation' + collapse-after: 5 + label: 'documentation' +change-template: '- $TITLE @$AUTHOR (#$NUMBER)' +change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks. +version-resolver: + major: + labels: + - 'major' + minor: + labels: + - 'minor' + patch: + labels: + - 'patch' + default: patch +template: | + ## Changes + + [Describe this new release here] + + $CHANGES diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml new file mode 100644 index 0000000..d012e25 --- /dev/null +++ b/.github/workflows/release-drafter.yml @@ -0,0 +1,27 @@ +name: Release Drafter + +on: + push: + # branches to consider in the event; optional, defaults to all + branches: + - main + # pull_request event is required only for autolabeler + pull_request: + # Only following types are handled by the action, but one can default to all as well + types: [opened, reopened, synchronize] + # pull_request_target event is required for autolabeler to support PRs from forks + # pull_request_target: + # types: [opened, reopened, synchronize] + +jobs: + update_release_draft: + runs-on: ubuntu-latest + steps: + # Drafts your next Release notes as Pull Requests are merged into "main" + - uses: release-drafter/release-drafter@v5 + # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml + # with: + # config-name: my-config.yml + # disable-autolabeler: true + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f792549 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,112 @@ +# Contributing to [PROJECT'S NAME] + +## Create an issue + +- If you've encountered a bug, open a [Bug Report](https://github.com/PoCInnovation/$REPOSITORY/issues/new?assignees=&labels=&template=bug_report.md&title=). +- If you want [PROJECT'S NAME] to have a new functionality, open a [Feature Request](https://github.com/PoCInnovation/$REPOSITORY/issues/new?assignees=&labels=&template=feature_request.md&title=). + +## Resolve an issue + +Select an [issue](https://github.com/PoCInnovation/$REPOSITORY/issues) that you want to resolve. + +The recommended workflow is to fork this repository and open pull requests from your fork. + +### 1. Fork, clone & configure [PROJECT'S NAME] upstream + +- Click on the _Fork_ button on GitHub +- Clone the original repository +- Add your repository as a new remote + +```sh +# Clone original repository +git clone git@github.com:PoCInnovation/$REPOSITORY.git + +# Add your fork as a remote +git remote add https://github.com/$YOUR_GITHUB_USER/$REPOSITORY.git +``` + +### 2. Create a pull request + +```sh +# Create a new branch +git switch -c my_branch + +# Make changes to your branch +# ... + +# Commit changes - remember to sign! +git commit -s + +# Push your new branch +git push + +# Create a new pull request from https://github.com/PoCInnovation/$REPOSITORY/pulls +``` + +### 3. Update your pull request with latest changes + +```sh +# Switch to the main branch +git switch main + +# Pull origin's change +git pull + +# Switch to your branch +git switch my_branch + +# Rebase your branch changes on top of the updated main branch +git rebase main + +# Update your pull request with latest changes +git push -f +``` + +## Commits + +### DCO + +Contributions to this project must be accompanied by a Developer Certificate of +Origin (DCO). + +All commit messages must contain the Signed-off-by line with an email address that matches the commit author. When committing, use the `--signoff` flag: + +```sh +git commit -s +``` + +The Signed-off-by line must match the **author's real name**, otherwise the PR will be rejected. + +### Commit messages + +Please read first this article : [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/). + +Then, follow these guidelines: + +- **Group Commits:** Each commit should represent a meaningful change. Instead, these commits should be squashed together into a single "Add Feature" commit. +> For instance, a PR should not look like : +> 1) Add Feature X +> 2) Fix Typo +> 3) Changes to features X +> 5) Bugfix for feature X +> 6) Fix Linter 7) +> 7) ... + +- Each commit should **work on its own**: it must compile, pass the linter and so on. +> This makes life much easier when using `git log`, `git blame`, `git bisect`, etc...\ +> For instance, when doing a `git blame` on a file to figure out why a change was introduced, it's pretty meaningless to see a _Fix linter_ commit message. "Add Feature X" is much more meaningful. + +- Use `git rebase -i main` to group commits together and rewrite their commit message + +- To add changes to the previous commit, use `git commit --amend -s`. This will change the last commit (amend) instead of creating a new commit. + +- Format: Use the imperative mood in the subject line: "If applied, this commit + will _your subject line here_" + +- Add the following prefixes to your commit message to help trigger [automated processes](https://www.conventionalcommits.org): + - `docs:` for documentation changes only (e.g., `docs: Fix typo in X`); + - `test:` for changes to tests only (e.g., `test: Check if X does Y`); + - `chore:` general things that should be excluded (e.g., `chore: Clean up X`); + - `ci:` for internal CI specific changes (e.g., `ci: Enable X for tests`); + +> Made with ❤️ by PoC diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..35c9b21 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [2023] [PoC Innovation] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..338a864 --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +> If you see this section, you've just created a repository using [PoC Innovation's Open-Source project template](https://github.com/PoCInnovation/open-source-project-template). Check the [getting started guide](./.github/getting-started.md). + +# [PROJECT'S NAME] + +[Project's description] + +## How does it work? + +[Explain how this project is working] + +## Getting Started + +### Installation + +[Explain how to install all of the project's dependencies] + +### Quickstart + +[Explain how to run this project] + +### Usage + +[Explain how to use this project] + +## Get involved + +You're invited to join this project ! Check out the [contributing guide](./CONTRIBUTING.md). + +If you're interested in how the project is organized at a higher level, please contact the current project manager. + +## Our PoC team ❤️ + +Developers +| [
[Developer's name]](https://github.com/MrZalTy) | [
[Developer's name]](https://github.com/MrZalTy) | [
[Developer's name]](https://github.com/MrZalTy) +| :---: | :---: | :---: | + +Manager +| [
[Manager's name]](https://github.com/adrienfort) +| :---: | + +

+Organization +

+ +

+ + LinkedIn logo + + + Instagram logo + + + Twitter logo + + + Discord logo + +

+

+ + Website logo + +

+ +> 🚀 Don't hesitate to follow us on our different networks, and put a star 🌟 on `PoC's` repositories + +> Made with ❤️ by PoC \ No newline at end of file