Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
110 lines (73 loc) · 4.22 KB

CONTRIBUTING.md

File metadata and controls

110 lines (73 loc) · 4.22 KB

Contributing to Keila

This document describes how to contribute code or translations to the Keila project.

Development Setup

Before you get started with developing Keila, you need to set up your development environment.

Option 1: Locally installed dependencies

Start by cloning the Keila Git repository:

git clone https://github.com/pentacent/keila.git

Keila requires the following tools to compile and run:

If you want to work on the frontend JavaScript code, it's also recommended you install dprint for formatting.

You use the asdf version manager (asdf install) to install these dependencies. Cmake can be installed with your system's package manager (e.g. apt install cmake or brew install cmake).

In addition, you need to have an instance of PostgreSQL to run Keila.

Option 2: Setup with VS Code and DevContainer

Warning

This method is not currently maintained. If you prefer working with Dev Containers, you might need to adjust the configuration.

  • Clone the repository: git clone https://github.com/pentacent/keila.git
  • Install the Remote Container extension in Visual Code
  • Click on the Screenshot of DevContainer icon icon in the bottom left corner and select Reopen in Container or look for Reopen in Container in the command panel (Ctrl+Shift+P)
  • Wait for the containers to build and install all the dependencies needed to run Keila, including PostgreSQL and Elixir
  • Open a terminal from VS Code and proceed with the instructions from the Run Keila section

Compile & Run Keila

  • Install dependencies with mix deps.get
  • Install dependencies and set up the database with mix setup
  • Start Keila server with mix phx.server

Now you can visit localhost:4000 from your browser.

Contributing Code

Code contributions to Keila are welcome!

If you don’t know where to start, take a look at these Good First Issues.

Contribution Guidelines

Before you commit code to Keila, make sure to run mix format to ensure consistent formatting.

If you're contributing JavaScript code, please run dprint fmt.

Contributor License Agreement (CLA)

Before we can accept your contribution, please sign the Contributor License Agreement (CLA).

Sign the CLA by running ./.cla/sign.sh and following the instructions in the terminal.

Read here about how the CLA works: CLA Readme

Translating Keila

Keila uses the Gettext format for translations of the interface.

Translation files are located in priv/gettext.

Getting Started

Before you create a new translation or modify an existing translation, you need to extract and update all strings from the code: mix gettext.extract --merge

Modify existing translations

Next you can use the editor of your choice to either edit the existing .po files in priv/gettext. A convenient Open Source program for editing translation files is Poedit.

Creating a new translation

  1. Use the .pot templates in priv/gettext to create translation files for your language . New translations should be stored in priv/gettext/:language/LC_MESSAGES.

  2. Find the line config :keila, KeilaWeb.Gettext in config/config.exs and add the language code of the new language to the :locales list.

  3. Find the line def available_locales() do in lib/keila_web/gettext.ex and add a tuple with the native language name and the language code to the list returned by the function.

Finalizing your changes

Run mix gettext.merge priv/gettext to compile your changes. Make sure to commit all changes to .pot, .po and the compiled .mo.