Commit 47714abf authored by Jean-Loup Haberbusch's avatar Jean-Loup Haberbusch

UPDATED FAQ & Git_Recipes

parent dbf40057
Pipeline #16657 passed with stages
in 25 seconds
......@@ -385,7 +385,7 @@ it.
### Why am I getting the following error: \<The application was unable to start correctly (0xc000007b)\> when I try to run my application?
[0xc000007berror](./assets/0xc000007berror.jpg)
![0xc000007berror](./assets/0xc000007berror.jpg)
This error likely comes from trying to run a 32 bit windows application
on a 64 bit environment. The most effective solution is to download
......
This page is made to give useful command or succession of commands to perform Git tasks in the context of the [CamiTK Git workflow](./CamiTK_Git_Branching_Model).
This page is made to give useful command or succession of commands to perform Git tasks in the context of the [CamiTK Git workflow](https://camitk.gricad-pages.univ-grenoble-alpes.fr/Docs/Getting%20Started/CamiTK%20Overviews/CamiTK_Git_Branching_Model/).
Be sure to follow both:
- The [branch naming convention](../../CamiTK%20Overviews/CamiTK_Git_Branching_Model/#naming-conventions)
- The [branch naming convention](https://camitk.gricad-pages.univ-grenoble-alpes.fr/Docs/Getting%20Started/CamiTK%20Overviews/CamiTK_Git_Branching_Model/#naming-conventions)
<!--
- The [commit message convention](./Core_developper_guidelines#Commit_messages)
-->
## Basic source Code Management using Git
### Clone the CamiTK repository and switch to develop branch
......@@ -84,11 +84,11 @@ Two types of development process are explained in this section:
- develop something new: you need to create a new feature
- fix a bug on the current development branch
The only thing that will change is how you name the local branch. Be sure to follow these [rules](/CamiTK_Git_Branching_Model#Naming_conventions "wikilink") for naming your branch.
The only thing that will change is how you name the local branch. Be sure to follow these [rules](https://camitk.gricad-pages.univ-grenoble-alpes.fr/Docs/Getting%20Started/CamiTK%20Overviews/CamiTK_Git_Branching_Model/#Naming_conventions) for naming your branch.
### Develop a new feature during the develop process
You need to create a specific local branch (see below, [Create a branch](#Create_a_branch_locally) and follow the rules for naming your branch: the branch should be named *feature/XXX* where XXX is a comprehensible (although rather short) description (e.g., *feature/connect-to-apple-store*).
You need to create a specific local branch (see below, [Create a branch](https://camitk.gricad-pages.univ-grenoble-alpes.fr/Docs/Getting%20Started/Examples%20and%20Tutorials/Git_recipes/#create-a-branch-locally) and follow the rules for naming your branch: the branch should be named *feature/XXX* where XXX is a comprehensible (although rather short) description (e.g., *feature/connect-to-apple-store*).
If the branch aim is to fulfil a feature, then "closes #XXX" should be mentioned in the branch description, where `#XXX` is the issue ID. This ensure a link from your branch to the issue (and will automatically closes the issues when your branch is merged to `develop`)
### Fix a Bug during the develop process
......@@ -99,7 +99,7 @@ Just proceed like for a new feature, with the difference that it should be prepe
As you are on the develop branch, the most usual case to work with Git is to do the job on a separate branch called feature branch creates from develop branch.
1. Choose a proper name for your branch (see [here](./CamiTK_Git_Branching_Model#Naming_conventions "wikilink"))
1. Choose a proper name for your branch (see [here](https://camitk.gricad-pages.univ-grenoble-alpes.fr/Docs/Getting%20Started/CamiTK%20Overviews/CamiTK_Git_Branching_Model/#naming-conventions)
2. Create the new branch and switch to the new branch:
```bash
......@@ -235,7 +235,7 @@ git push origin --delete release/4.0.0
### Fix a Bug during the release process
You are in the release process on the release branch and your are correcting a bug: just follow the [CamiTK Branching - Naming convention](/CamiTK_Git_Branching_Model#Naming_conventions) as described by the picture in [depot referentiel](/CamiTK_Git_Branching_Model#Working_with_depot).
You are in the release process on the release branch and your are correcting a bug: just follow the [CamiTK Branching - Naming convention](https://camitk.gricad-pages.univ-grenoble-alpes.fr/Docs/Getting%20Started/CamiTK%20Overviews/CamiTK_Git_Branching_Model/#naming-conventions) as described by the picture in [depot referentiel](https://camitk.gricad-pages.univ-grenoble-alpes.fr/Docs/Getting%20Started/CamiTK%20Overviews/CamiTK_Git_Branching_Model/#working-with-depot).
If you fixed an important bug that you want to commit immediately to the develop branch for some reasons, follow the steps below to make your corrections available in the develop branch without waiting the end of release process.
......@@ -261,7 +261,7 @@ git checkout -b release/4.0.0 origin/release/4.0.0
### Create a specific release branch
From the master branch create a new hotfix branch by respecting the [branch naming convention](/CamiTK_Git_Branching_Model#Naming_conventions).
From the master branch create a new hotfix branch by respecting the [branch naming convention](https://camitk.gricad-pages.univ-grenoble-alpes.fr/Docs/Getting%20Started/CamiTK%20Overviews/CamiTK_Git_Branching_Model/#naming-conventions).
``` bash
git checkout -b hotfix-4.0.1 master # Switched to a new branch "hotfix-4.0.1"
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment