Contributing to Callico
We welcome every contribution possible to improve Callico. Whether it is Python code, translations, design suggestions, small fixes, etc.
If you want to discuss some ideas, send us an email at
callico (at) teklia.com!
Cloning the source code
It is as simple as running the following command:
git clone firstname.lastname@example.org:callico/callico.git
As Callico is open-source, you do not need any authentication to retrieve its source code. However, if you wish to work on Callico source code and submit patches, you will need to authenticate yourself. Steps to do so are detailed just below.
We assume you already have:
- a working git client installation on your computer
- an SSH key to authenticate yourself on a GitLab instance
You can find more information here.
Sign up on Teklia's GitLab instance
At Teklia, we use GitLab a lot. We use it to host all our source code, work as a team, build and ship our projects, etc.
You can sign up on Teklia's GitLab instance here.
Please note that your account will need to be approved by an administrator which could take up to one business day.
Add your SSH key
Do not use HTTPS to clone a repository, it will require you to type your GitLab password when cloning/pushing.
To gain and keep access on Callico's GitLab repository as a contributor, your GitLab account must be protected with Multiple Factor Authentication (generally using one time passwords generated from your phone).
If you do not complete the 2FA initial activation within 48 hours of creating your account, it will be automatically disabled.
Submitting a patch to Callico's source code
We use GitLab to track issues (either bugs, or new features).
You can look at Callico's issues from different views:
- through the current milestone, the most important issues are listed there, as they are the most time-sensitive
- through the full issue list
Please ask first if you can work on an issue, by simply commenting on it. Be aware that some issues may be way more complex than others.
Issues should have a priority label:
- P1 are high priority, usually bugs badly affecting users experience,
- P2 are at the normal priority level
- P3 are low priority
If nothing is set, assume P2 by default.
Work on a branch
To start working on a patch, you must first create a git branch, based on the current
# Start from master
git checkout master
# Update master to latest available revision
git pull origin master
# Create a new branch
git checkout -b my-new-branch
Each new commit will then be stored on that new branch named
To name your branch, use a name:
- in English,
- in lowercase,
- without spaces, use dashes
-to link words,
- explicit and related to your current work.
Here are some examples of suitable branch names:
remove-model-xwhen the goal is to remove a Django model named
fix-invalid-chars-searchwhen the patch fixes a bug related to search
- naming your branch with the issue ID, we prefer explicit naming here,
- using another language than English,
- spaces, camelCase, underscores, etc.
Publish your work
You are allowed to push directly on Callico's repository, except for the
master branch. The goal is for your code to reach
master once the following steps are completed:
- unit tests are all OK, meaning that all jobs in the CI stage named
testended in success
- formatting has been validated by a tool, meaning that all jobs in the CI stage named
checksended in success
- the code itself has been approved by a human reviewer
To get approvals, you need to create a Merge Request (also called MR) on GitLab.
When pushing your code from your local branch, you will notice some output in the console with a link towards
gitlab.teklia.com: it will allow you to create a Merge Request (or view the previously created one) in 2 clicks.
Once your work is ready, configure your Merge Request as follows:
- Assign yourself as the Assignee.
- Assign @babadie as the Reviewer, he will either review or re-assign to another reviewer when needed.
- Set an explicit name, in English, properly formatted.
- Add a reference to the issue you are working on in the description:
Closes #XYZif you fully solve the mentioned issue,
Ref #XYZif you only want to link your Merge Request to the issue.
- Fill in the description with an explanation of the changes you made.
- If the related issue has a milestone set, set the same milestone on this Merge Request.
If you are not confident the work being published is yet ready for review, you can prefix your Merge Request name with
Draft:; that will tell the reviewer to wait a bit before diving into your code. Do not forget to remove that prefix once your code is ready.
The reviewer may leave some comments directly on the Merge Request, asking you for updates. Please resolve all of them (or discuss them if you disagree), publish some commits fixing the issues, and then ask for a new review. Rinse and repeat until the reviewer approves and merges your code!
Update your branch
As other developers are working on Callico, sometimes features/bugfixes/etc will land on
master while your Merge Request touches the same parts. You may get conflicts here and will need to solve them using a rebase.
It is your responsibility, as a developer, to maintain your code in a mergeable state: no conflicts and up to date with the latest
To update using rebase, while working on your branch:
# Retrieve the latest updates from master
git fetch origin master
# Now the remote reference to origin/master has been updated, you can rebase on top of it
# Be aware that the local reference to master is not yet updated, it is only updated with git pull
git rebase origin/master
git rebase operation will ask you to solve manually conflicts (if any). Please follow this guide or ask us for help if you are lost.
Landing your code
If you have reached this step, congratulations and many thanks! Your code has been approved and should already be merged, as that is the responsibility of the reviewer.
Your work will be shipped in the next Callico release along with latest features, bugfixes and other contributions.