Merge pull request #3 from PoCInnovation/asyncflow/init

Asyncflow/init

Author: lg-epitech

.github/getting-started.md

@@ -18,10 +18,12 @@ For each of the following branches, add the required protections.
 
 ```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
@@ -36,6 +38,7 @@ This template provides the must-have documents.
 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
@@ -49,6 +52,7 @@ Fill every sections of the [CONTRIBUTING.md](/CONTRIBUTING.md).
 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).
@@ -66,6 +70,7 @@ This template provides the must-have templates.
 An issue is a tool to track and focus tasks.
 
 This template provides two issues templates :
+
 - `Bug Report`
 - `Feature Request`
 
@@ -119,6 +124,7 @@ This template provides some GitHub actions.
 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
@@ -138,18 +144,19 @@ A task is associated as an issue.
 
 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
+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

.github/pull_request_template.md

@@ -28,4 +28,4 @@ Please complete this section if any breaking changes have been made, otherwise d
 
 # Additional comments
 
-Please post additional comments in this section if you have them, otherwise delete it.
+Please post additional comments in this section if you have them, otherwise delete it.

.github/release-drafter.yml

@@ -1,37 +1,37 @@
-name-template: 'v$RESOLVED_VERSION 🌈'
-tag-template: 'v$RESOLVED_VERSION'
+name-template: "v$RESOLVED_VERSION 🌈"
+tag-template: "v$RESOLVED_VERSION"
 categories:
-  - title: '🚀 Features'
+  - title: "🚀 Features"
     collapse-after: 5
     labels:
-      - 'feature'
-      - 'enhancement'
-  - title: '🐛 Bug Fixes'
+      - "feature"
+      - "enhancement"
+  - title: "🐛 Bug Fixes"
     collapse-after: 5
     labels:
-      - 'fix'
-      - 'bugfix'
-      - 'bug'
-  - title: '🧰 Maintenance'
+      - "fix"
+      - "bugfix"
+      - "bug"
+  - title: "🧰 Maintenance"
     collapse-after: 5
     labels:
-      - 'chore'
-      - 'dependencies'
-  - title: '📄 Documentation'
+      - "chore"
+      - "dependencies"
+  - title: "📄 Documentation"
     collapse-after: 5
-    label: 'documentation'
-change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+    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'
+      - "major"
   minor:
     labels:
-      - 'minor'
+      - "minor"
   patch:
     labels:
-      - 'patch'
+      - "patch"
   default: patch
 template: |
   ## Changes

.github/workflows/release-drafter.yml

@@ -24,4 +24,4 @@ jobs:
         #   config-name: my-config.yml
         #   disable-autolabeler: true
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CONTRIBUTING.md

@@ -84,17 +84,20 @@ Please read first this article : [How to Write a Git Commit Message](https://chr
 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) ...
+
+  > For instance, a PR should not look like :
+  >
+  > 1. Add Feature X
+  > 2. Fix Typo
+  > 3. Changes to features X
+  > 4. Bugfix for feature X
+  > 5. Fix Linter 7)
+  > 6. ...
 
 - 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.
+
+  > 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
 

README.md

@@ -28,27 +28,29 @@ It works.
 
 [Explain how to install all of the project's dependencies]
 AsyncFlow presents itself as a node package (supposedly).
+
 ```bash
 npm install asyncflow
 ```
 
 ### Quickstart
 
 Boilerplate:
+
 ```ts
 import { AsyncFlow } from "asyncflow/sdk";
 ```
 
 ### Usage
 
 Boilerplate:
+
 ```ts
 import { AsyncFlow } from "asyncflow/sdk";
 
-AsyncFlow("mail")
+AsyncFlow("mail");
 ```
 
-
 ## Get involved
 
 You're invited to join this project ! Check out the [contributing guide](./CONTRIBUTING.md).