From 83386dfc6796c17d0c7714bcf09b6ecb423e8a92 Mon Sep 17 00:00:00 2001 From: Raphael Nestler Date: Thu, 14 Mar 2024 07:46:05 +0100 Subject: [PATCH] Rename master to main in contributing docs (#146) --- docs/_sources/contributing.rst.txt | 14 +++++++------- docs/contributing.rst | 14 +++++++------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/_sources/contributing.rst.txt b/docs/_sources/contributing.rst.txt index 5ddc89f8..c603b14e 100644 --- a/docs/_sources/contributing.rst.txt +++ b/docs/_sources/contributing.rst.txt @@ -11,10 +11,10 @@ We have a set of branches on the remote Git server. Some branches are temporary, and others are constant throughout the life of the repository. * Branches always present in the repository: - * *master*: You have the latest released to production, receive merges from the develop branch, or merge from a *hotfix* branch (emergency). - * Do I have to put a TAG when doing a merge from develop to master? yes - * Do I have to put a TAG when doing a merge from a hotfix branch to master? yes - * After merge from a hotfix to master, do I have to merge from master to develop? yes + * *main*: You have the latest released to production, receive merges from the develop branch, or merge from a *hotfix* branch (emergency). + * Do I have to put a TAG when doing a merge from develop to main? yes + * Do I have to put a TAG when doing a merge from a hotfix branch to main? yes + * After merge from a hotfix to main, do I have to merge from main to develop? yes * *develop*: It is considered the "Next Release", receives merges from branches of each developer, either corrections (*fix*) or new features (*feature*). * Temporary branches: @@ -27,8 +27,8 @@ Some branches are temporary, and others are constant throughout the life of the * When I finish the correction in my fix branch, which branch to merge into?: You always merge feature branch into develop branch * *hotfix/\\-\*: When we are correcting an emergency incidence in production, we create a local branch with the prefix "hotfix/", then only if there is a task id, we indicate it and we add a hyphen. The following we indicate a description according to the functionality that we are correcting. The words are separated by hyphens. - * Where does this branch emerge?: This branch always emerge from the master branch - * When I finish the correction in my hotfix branch, which branch to merge into?: This branch always emerge from the master and develop branch + * Where does this branch emerge?: This branch always emerge from the main branch + * When I finish the correction in my hotfix branch, which branch to merge into?: This branch always emerge from the main and develop branch * Steps to follow when you are creating or going to work on a branch of any kind (feature / fix / hotfix): 1. After you create your branch (feature / fix / hotfix) locally, upload it to the remote Git server. The integration system will verify your code from the outset. @@ -200,4 +200,4 @@ And the produced output doc will be: .. image:: contributing/method_way_sphinx.png -As you may notice, if you don't use any docstring, the method documentation will be empty. \ No newline at end of file +As you may notice, if you don't use any docstring, the method documentation will be empty. diff --git a/docs/contributing.rst b/docs/contributing.rst index 5ddc89f8..c603b14e 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -11,10 +11,10 @@ We have a set of branches on the remote Git server. Some branches are temporary, and others are constant throughout the life of the repository. * Branches always present in the repository: - * *master*: You have the latest released to production, receive merges from the develop branch, or merge from a *hotfix* branch (emergency). - * Do I have to put a TAG when doing a merge from develop to master? yes - * Do I have to put a TAG when doing a merge from a hotfix branch to master? yes - * After merge from a hotfix to master, do I have to merge from master to develop? yes + * *main*: You have the latest released to production, receive merges from the develop branch, or merge from a *hotfix* branch (emergency). + * Do I have to put a TAG when doing a merge from develop to main? yes + * Do I have to put a TAG when doing a merge from a hotfix branch to main? yes + * After merge from a hotfix to main, do I have to merge from main to develop? yes * *develop*: It is considered the "Next Release", receives merges from branches of each developer, either corrections (*fix*) or new features (*feature*). * Temporary branches: @@ -27,8 +27,8 @@ Some branches are temporary, and others are constant throughout the life of the * When I finish the correction in my fix branch, which branch to merge into?: You always merge feature branch into develop branch * *hotfix/\\-\*: When we are correcting an emergency incidence in production, we create a local branch with the prefix "hotfix/", then only if there is a task id, we indicate it and we add a hyphen. The following we indicate a description according to the functionality that we are correcting. The words are separated by hyphens. - * Where does this branch emerge?: This branch always emerge from the master branch - * When I finish the correction in my hotfix branch, which branch to merge into?: This branch always emerge from the master and develop branch + * Where does this branch emerge?: This branch always emerge from the main branch + * When I finish the correction in my hotfix branch, which branch to merge into?: This branch always emerge from the main and develop branch * Steps to follow when you are creating or going to work on a branch of any kind (feature / fix / hotfix): 1. After you create your branch (feature / fix / hotfix) locally, upload it to the remote Git server. The integration system will verify your code from the outset. @@ -200,4 +200,4 @@ And the produced output doc will be: .. image:: contributing/method_way_sphinx.png -As you may notice, if you don't use any docstring, the method documentation will be empty. \ No newline at end of file +As you may notice, if you don't use any docstring, the method documentation will be empty.