Contribute

Crowl is an open-source project, and aims to be community-based. Whichever your language or your experience, there are several ways to contribute:

You can also spread the word and tell your friends to use Crowl! The more the merrier ;-)

Bug report

If you found a bug or encountered a problem, please report it: we might be able to help you quickly, or add a fix to our roadmap. Moreover, this will also help other users who might have the same problem.

Here are a few guidelines for bug reporting:

  1. Make sure you use the latest version of Crowl.
  2. Go to our issue-tracker and select the appropriate project.
  3. Check if someone else encountered this problem. If the problem was already solved, check if the answer works for you.
  4. If no one reported the problem, create a new issue with the bug label. Remember to be as descriptive as possible.

Features ideas

This project is still in a very early stage, and a lot can be done to improve it. However, your ideas are welcome.

You can submit your ideas on Gitlab by creating an issue:

  1. Check the list of proposed features: we're like Google, we don't like duplicate content ;-)
  2. Create a new issue with the feature label.
  3. Be as precise as possible to explain your idea. It's likely other users will discuss its relevance and feasibility.

Documentation & translation

The best way to contribute to documenting and translating Crowl is to contact us: we'll discuss how you can help.

Developpers

If you're a developer and want to help, you're very welcome!

First of all, you need to create a copy of the project:

  1. Go to https://gitlab.com/crowltech/crowl and fork the project to get your own copy.
  2. Clone the project to your local computer:
    git clone git@gitlab.com:your-username/crowl.git
  3. Add the upstream repository:
    git remote add upstream git@gitlab.com:crowltech/crowl.git
  4. You now have two remote repositories:
    • upstream, which refers to the main crowl repository
    • origin, which refers to your personal fork


You can now develop your own contribution:

  1. Pull the latest changes from the main repository:
    git checkout master
    git pull upstream master
  2. Create a branch for the issue you want to work on. Please use an understandable name to help reviewers know which feature you are working on. For example if you want to submit a bugfix for issue 123, name your branch bugfix-for-issue-123.
    git checkout -b bugfix-for-issue-123
  3. Commit locally as you progress (git add and git commit)


Once you finished your work, submit your contribution:

  1. Push your changes back to your fork on Gitlab:
    git push origin bugfix-for-issue-123
  2. Go to Gitlab and click the Merge request button for your branch.


Other contributors will test your branch to check if everything is OK, then add your feature or bugfix to the main branch.

Get Connected