From 346f175b3691e5877f1bd357535e2c5fe5962a90 Mon Sep 17 00:00:00 2001 From: Julien Oculi Date: Tue, 4 Jun 2024 15:25:57 +0200 Subject: [PATCH] doc: improve usage and contribution --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 1df3d05..bce9b66 100644 --- a/README.md +++ b/README.md @@ -32,3 +32,23 @@ Formats : - `user` : `${firstname}.${lastname}` - `user_subdomain` : `${firstname}-${lastname}` + +## Usage + +1. Cloner le repo. +1. Lancer le serveur. + - Executer `deno task start` //Serveur sur le port 8000 par default. + - Ou, executer `PORT=7000 deno task start` //Spécifier le port d'écoute + désiré. + - Ou, utiliser le service définit dans + `cohabit/server_config/portfolio_server`. + +## Contribution + +1. Install [deno](https://deno.land). +1. Follow + [deno convention](https://docs.deno.com/runtime/manual/references/contributing/style_guide). +1. Follow + [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). +1. Follow [sermver](https://semver.org/lang/fr/). +1. Run and check `deno task check` before any commit.