From f289afb0ee3feeb9c07ae303bff413030623e147 Mon Sep 17 00:00:00 2001 From: Alexis Drai Date: Thu, 22 Sep 2022 21:26:11 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index bafc8a4..6fa6ad8 100644 --- a/README.md +++ b/README.md @@ -11,16 +11,28 @@ [![Technical Debt](https://codefirst.iut.uca.fr/sonar/api/project_badges/measure?project=dice-app&metric=sqale_index&token=bf024850973b7556eef0b981a1b838867848005c)](https://codefirst.iut.uca.fr/sonar/dashboard?id=dice-app) [![Vulnerabilities](https://codefirst.iut.uca.fr/sonar/api/project_badges/measure?project=dice-app&metric=vulnerabilities&token=bf024850973b7556eef0b981a1b838867848005c)](https://codefirst.iut.uca.fr/sonar/dashboard?id=dice-app) # dice_app: the die throwing app + +## To use the app + +TLDR: you can't really + +Open the *DiceApp* solution and navigate to the *App* project. The *Program.cs* file has a `Main()` method that can be launched. It will soon be able to load a stub. Then you will be able to play a console prototype / perform functional tests. But it isn't ready yet. + ## To contribute (workflow) + We are using the feature branch workflow ([details here](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow), or see the summary below) + ### 1 - Sync with the remote + Make sure you're working with the latest version of the project ``` git checkout main git fetch origin git reset --hard origin/main ``` + ### 2 - Create a new branch + Give your new branch a name referring to an issue (or maybe a group of similar issues) ``` git checkout -b new-feature @@ -30,16 +42,22 @@ Regularly, you might want to get all the new code from your main branch, to work ``` git pull --rebase origin main ``` + ### 3 - Code + :fire::technologist::bug::fire:............:white_check_mark: + ### 4 - Save your changes to your new branch + For a refresher, see details about `add`, `commit`, `push`, etc. [here](https://www.atlassian.com/git/tutorials/saving-changes) It should involve creating a corresponding feature branch on the remote repository ``` git push -u origin new-feature ``` + ### 5 - Create a Pull Request + On [the repository's main page](https://codefirst.iut.uca.fr/git/alexis.drai/dice_app), or on your new branch's main page, look for a `New Pull Request` button. It should then allow you to `merge into: ...:main` and `pull from: ...:new-feature`