> For the complete documentation index, see [llms.txt](https://b-it-bots.gitbook.io/wiki/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://b-it-bots.gitbook.io/wiki/home/_getting-started/adding-your-first-contribution.md).

# Adding your first contribution

## Getting a task

During our meetings, we will usually discuss what are the important things on the team's to-do list. Once you have completed the first steps and tutorials, we will assign an [issue](https://github.com/b-it-bots/mas_domestic_robotics/issues) to you. You can also browse that list and find something that looks interesting for you.

{% hint style="info" %}
You can find good issues for new members by filtering the [label 'good first issue'](https://github.com/b-it-bots/mas_domestic_robotics/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
{% endhint %}

## Create a branch

Before you start working, you should create a branch where you will save your changes.

{% hint style="warning" %}
See [why should I avoid making commits in my kinetic or devel branch?](/wiki/home/_faq/git.md#why-should-i-avoid-making-commits-to-the-kinetic-or-devel-branch)
{% endhint %}

Our repositories usually have the following branches:

* `kinetic` - the stable branch which contains code which *rarely* fails and has been thoroughly tested.
* `devel` - the development branch where you will find the *latest* version of our code, including bug fixes, new features and experimental code.

As a developer, you will usually always start your work based on the `devel` branch. Depending on what you are working on, try to follow our branch naming conventions:

* `feature/name-of-feature`: New functionality that will be added to the robot.  Make the `name-of-feature` part as descriptive as possible.
* `fix/issue-NNN`: Fixing a bug that was found in existing code. If there is no issue for the bug you are trying to fix, just use a descriptive title.

To create a new branch which is based on `devel`, you can run the following command:

```
git checkout -b <new branch> devel
```

For example:

```
git checkout -b feature/my-very-descriptive-feature devel
```

For more information please look into the [branching model guide](/wiki/home/_conventions/git/branching-model.md).

## Making modifications

Start working on your new task. From time to time, commit your work (and try to [make good commits](/wiki/home/_conventions/git.md#how-to-write-good-commits)).

### Add a new remote

You will eventually need to push your changes to your own fork. For that, you need to [add a new remote in your laptop](https://help.github.com/en/articles/adding-a-remote).

You can list the remotes in your repository with the following command:

```
git remote -v
```

By convention, the base repository (in this case, the b-it-bot's one) is called the *upstream*. Your fork is called *origin*.

First, let's rename the b-it-bots remote to match that:

```
git remote rename origin upstream
```

Now let's add your fork as origin:

```
git remote add origin git@github.com:<your GitHub user name>/<name of repository>.git
```

Here is an example with the `mas_domestic_robotics` repository:

![](/files/-Lf3rSrTzvKlWoiPYu6V)

{% hint style="info" %}
See [what is the difference between origin and upstream?](/wiki/home/_faq/git.md#what-is-the-difference-between-origin-and-upstream)
{% endhint %}

### Create a pull request

Once you have made some progress, [create a pull request](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork) (often abbreviated PR) from your fork to `b-it-bots/mas_domestic_robotics`'s `devel` branch:

![](/files/-Lf0d7MNVL8cEdjeR_0T)

Once you press the create pull request button, a form will appear. Try to follow the guidelines below:

* Make the title of your PR descriptive. If it's not ready to be merged yet, it's convention to add **WIP:** at the beginning of the title. You can also [mark your PR as a draft](https://github.blog/2019-02-14-introducing-draft-pull-requests/).
* Add a (small) text describing what your changes are doing
* Apply any labels that apply
* Request a review from the senior members (GitHub will add some of them automatically, and will suggest some others).&#x20;