doc: improve usage and contribution

This commit is contained in:
Julien Oculi 2024-06-04 15:25:57 +02:00
parent c558fec112
commit 346f175b36

View file

@ -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.