How to contribute to robocomp Github repository

How to contribute to robocomp Github repository¶

In brief, the steps involved will be:

Fork the robocomp repository
Clone the repository
Create a new branch
Switch to the created branch
Make suitable changes
Test the changes
Add the files you want to commit
Commit the files
Push to the repository
Compare changes
Pull a request for the commit made
Start a discussion over the commits made

In detail explanation:

Forking the repository:

Open the robocomp Github repository : https://github.com/robocomp/robocomp

Click on the fork option as shown below:

The indication that the repo is forked can be observed as follows:

Cloning the repository:

Open a terminal and move to home directory and type:

git clone <link to the forked repository>

Creating a branch:

Open a terminal and move the “pwd” to the place where the forked repository is present.

To see a list of all branches present and to see the current working branch type and execute:

git branch

Create a new branch to work on. There is no restriction wrt the naming of the branch:

git branch <branch_name>

To switch to the branch that you created to work on execute:

git checkout <branch_name>

Making changes:

Demo: let’s make changes to Readme.md

Commit the changes made

To get a list of all the files to which changes have been made type:

git status

Next add only those files which we want to commit by typing:

git add <filename>

Now commit the changes by using the command:

git commit -m 'commit message'

Push the commit to the repository:

git push origin <current_working_branch_name>

Compare and pull request

Discuss the commits you have made with the rest of the contributing team.