navego-contribution-workflow updated

zbai · Jun 26, 2022 · cf23c2c · cf23c2c
1 parent bcca7df
commit cf23c2c
Showing 1 changed file with 6 additions and 7 deletions.
diff --git a/doc/github-workflow.md → doc/navego-contribution-workflow.md b/doc/github-workflow.md → doc/navego-contribution-workflow.md
@@ -1,26 +1,23 @@
 
+# NaveGo contribution workflow
 
-# The Github workflow
-
-The main idea is to follow the [github worflow](https://docs.github.com/en/get-started/quickstart/github-flow).
-
-There is nothing new about our methodology, but since the github doc is large, following it is a summary about it.
+The main idea is to follow the [github worflow](https://docs.github.com/en/get-started/quickstart/github-flow). There is nothing new about our methodology, but since the Github worflow document is large, next a summary is provided.
 
 1. We work hierarchically with 2 branches simultaneously:
 
     `main`: Production branch. Nothing is merged to `main` except there is a strong consensus among all the participants working on the repository. Only the `develop` branch can be merged to the `main` branch.
 
     `develop`: it is the integration branch used by all the branches to merge particular changes.
 
-2. For each new feature we need to create a new topic branch. These branches should always be created from `develop`. The process is the following:
+2. For each new feature you need to create a new topic branch. These branches should always be created from `develop`. The process is the following:
 
     a. Download the complete repository: `git clone htpp://github.com/<user>/<repository>.git`
 
     b. Change to branch develop: `git checkout develop`.
 
     c. Get the last version from origin: `git pull origin develop`.
 
-    d.  Create a new branch from develop and change to that new branch: `git checkout -b <branch-name> develop`. You can change to any branch just doing `git checkout <branch-name>`.
+    d.  Create a new branch from develop and change to that new branch: `git checkout -b <branch-name> develop`. 
 
     e. Then you work on the new branch adding a new feature or fixing a bug.
 
@@ -58,4 +55,6 @@ Then, the version history is usually keeped by adding tags in `main` (you can ad
 ### Unstage a file (uncommit)
 `git restore --staged <file>...`
 
+### Change to any branch 
+`git checkout <branch-name>`.