From d04354410e3a572432d0d65f82a7d30cc6e1a7f1 Mon Sep 17 00:00:00 2001 From: thegm445 Date: Wed, 11 Oct 2023 11:43:29 -0300 Subject: [PATCH] docs(contributing): code from another PR removed, correct code added --- .github/CONTRIBUTING.md | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 090507c..e08b5fd 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,10 +1,12 @@ +Sure, here's the adapted markdown code using GitLab Flow: + # Contributing Rules - The development will be done **in English**. - Commit messages **must** follow [Conventional Commits specifications](https://www.conventionalcommits.org/en/v1.0.0/#specification). - Branches **must** follow the -[Git Flow pattern](https://github.com/nvie/gitflow). +[GitLab Flow pattern](https://docs.gitlab.com/ee/topics/gitlab_flow.html). - Versioning must follow the [Semantic Versioning specifications](https://semver.org/). - Every contribution **must** be accompanied by a test suite that tests the new @@ -28,28 +30,22 @@ response was given then the issue will be closed. ## Starting -This guide assumes you have -[Git Flow](https://github.com/nvie/gitflow/wiki/Installation) installed on your -system. The `main` branch is **always** the production branch, and the -`develop` branch is **always** the development branch. +This guide assumes you have [GitLab Flow pattern](https://docs.gitlab.com/ee/topics/gitlab_flow.html) installed on your system. The `main` branch is **always** the production branch. To create a feature/bugfix branch, use the command: ```sh -git flow feature start +git checkout -b main # or -git flow bugfix start +git checkout -b main ``` -Git Flow will automatically create and checkout the branch, make the changes in -your favorite code editor. When you're done with the changes, commit and use -the following command to publish the feature on GitHub: +Git will automatically create and checkout the branch, make the changes in your favorite code editor. When you're done with the changes, commit and use the following command to publish the feature on GitLab: ```sh -git flow feature publish +git push origin # or -git flow bugfix publish +git push origin ``` -The branch should automatically be published on GitHub. Wait a supervisor to -review your code and merge or request changes if necessary. +The branch should automatically be published on GitLab. Wait a supervisor to review your code and merge or request changes if necessary.